From 189e9ad476966398e661977aa447503031f42553 Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Tue, 26 May 2026 15:33:35 -0300 Subject: [PATCH 1/7] feat(Add shipping address and select delivery option): add information about delivery options --- VTEX - Checkout API.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index 29fdb7864..7da6735bd 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -5273,7 +5273,7 @@ "post": { "tags": ["Cart attachments"], "summary": "Add shipping address and select delivery option", - "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 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.", + "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r>ℹ️ This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request.\r\n\r\nIf no `selectedSla` is sent in the request body, the API will automatically select the best delivery option among the ones available in the `slas` array, excluding pickup options and scheduled delivery options. If no such option is available, none will be selected.\r\n\r\nThe best delivery option selected is the one that can fulfill the biggest item quantity for the lowest price. This selection does not consider delivery time.\r\n\r\nThis process happens after the White Label Sellers selection in the Checkout pipeline. White label sellers selection is a separate process and is the responsibility of the Order Allocation module. For more information, see the [White label sellers selection](https://help.vtex.com/en/docs/tutorials/white-label-sellers-selection) article.\r\n\r\nFor a pickup option or a scheduled delivery option to be selected, it must be explicitly sent in the request body in the `selectedSla` field.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "AddShippingAddress", "security": [], "parameters": [ @@ -5414,7 +5414,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`. If the store uses the [Delivery Option](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`.", + "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", "example": "normal", "nullable": true } @@ -31003,7 +31003,7 @@ }, "selectedSla": { "type": "string", - "description": "SLA selected by the customer. If the store uses the [Delivery Option](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`.", + "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", "nullable": true }, "selectedDeliveryChannel": { @@ -32952,7 +32952,7 @@ }, "selectedSla": { "type": "string", - "description": "SLA selected by the customer. If the store uses the [Delivery Option](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`.", + "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", "nullable": true }, "selectedDeliveryChannel": { @@ -35441,7 +35441,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected shipping option. If the store uses the [Delivery Option](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`.", + "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", "example": "Express", "nullable": true }, @@ -36546,7 +36546,7 @@ }, "selectedSla": { "type": "string", - "description": "SLA selected by the customer. If the store uses the [Delivery Option](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`.", + "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", "nullable": true }, "selectedDeliveryChannel": { From 8df2a734ea6a0060082e0b6a6f92c7c529832edd Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Tue, 26 May 2026 16:02:43 -0300 Subject: [PATCH 2/7] feat(new field): add minimumOrderValue --- VTEX - Checkout API.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index 7da6735bd..89d26fd23 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -31652,6 +31652,11 @@ "type": "string", "description": "Seller logo.", "nullable": true + }, + "minimumOrderValue": { + "type": "integer", + "description": "Minimum order value configured at the seller, in cents.", + "nullable": true } } } @@ -36335,6 +36340,11 @@ "type": "string", "description": "Seller logo.", "nullable": true + }, + "minimumOrderValue": { + "type": "integer", + "description": "Minimum order value configured at the seller, in cents.", + "nullable": true } } } @@ -39043,6 +39053,11 @@ "type": "string", "description": "Seller logo.", "nullable": true + }, + "minimumOrderValue": { + "type": "integer", + "description": "Minimum order value configured at the seller, in cents.", + "nullable": true } } } From 75674d26e82a93ed6b83f852ad25ff559be9646a Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Wed, 27 May 2026 16:09:22 -0300 Subject: [PATCH 3/7] feat(checkout api): improve isDisposable description --- VTEX - Checkout API.json | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index 89d26fd23..c99b98538 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -4839,7 +4839,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -30544,7 +30544,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -30940,7 +30940,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -31280,7 +31280,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -31353,7 +31353,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -32499,7 +32499,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -32894,7 +32894,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -33203,7 +33203,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -33276,7 +33276,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -34340,7 +34340,7 @@ "nullable": true }, "isDisposable": { - "description": "Is disposable.", + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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.", "type": "boolean" }, "postalCode": { @@ -36493,7 +36493,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -36802,7 +36802,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -36875,7 +36875,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -37941,7 +37941,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -38341,7 +38341,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -38681,7 +38681,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -38754,7 +38754,7 @@ }, "isDisposable": { "type": "boolean", - "description": "Indicates whether address is disposable." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", From 65c25eef4b02f1bcf5c8a9507fefb4e424d69292 Mon Sep 17 00:00:00 2001 From: karenkrieger <> Date: Wed, 27 May 2026 19:33:10 +0000 Subject: [PATCH 4/7] chore: update postman files --- PostmanCollections/VTEX - Checkout API.json | 314 ++++++++++---------- 1 file changed, 157 insertions(+), 157 deletions(-) diff --git a/PostmanCollections/VTEX - Checkout API.json b/PostmanCollections/VTEX - Checkout API.json index f0f60dcce..ba8137475 100644 --- a/PostmanCollections/VTEX - Checkout API.json +++ b/PostmanCollections/VTEX - Checkout API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "1524f754-3c08-4f2c-94c9-444787f01a51" + "postman_id": "2faa7998-9687-4ae0-8fb6-f7a882af654f" }, "item": [ { - "id": "793ce1d2-68d2-4839-9f35-22ee721add78", + "id": "203e9d88-54b6-4b9a-a156-c942904e51ae", "name": "Shopping cart", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "52f6c283-b952-4ea8-999c-826167414c55", + "id": "c82fa44f-42f8-4246-9751-a77fe7f9527e", "name": "Cart simulation", "request": { "name": "Cart simulation", @@ -107,7 +107,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3761ea4e-b101-46eb-9d69-1eff4f6f04f5", + "id": "e51a547a-87d6-4815-82cf-05d806defc90", "name": "OK", "originalRequest": { "url": { @@ -216,7 +216,7 @@ { "listen": "test", "script": { - "id": "2da2a6a0-663c-441c-b4d9-7131e9429ed0", + "id": "decbaac8-fc65-460f-8ac6-002ca0585723", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForms/simulation - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -232,7 +232,7 @@ } }, { - "id": "dee3cb39-86f8-4dfb-98f1-f65798cc752c", + "id": "f6997894-4e98-453c-9fd9-e0a9e3012edf", "name": "Get current or create a new cart", "request": { "name": "Get current or create a new cart", @@ -304,7 +304,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "90a4fd1b-f34a-48f6-9ff7-43c5ff8793e1", + "id": "9737f131-4b2a-4bec-8b96-0e5dd18f248b", "name": "OK", "originalRequest": { "url": { @@ -390,13 +390,13 @@ { "listen": "test", "script": { - "id": "311aa87d-a8d0-4dbc-a00b-204b0280dac7", + "id": "22c98758-5b93-4e82-9a64-5a129596a2f5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/orderForm - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/checkout/pub/orderForm - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/checkout/pub/orderForm - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/orderForm - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/orderForm - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -406,7 +406,7 @@ } }, { - "id": "172f87a6-c759-4868-ab2a-bef3b210dfae", + "id": "3796b976-c704-4b53-971c-82841cd4f185", "name": "Get cart information by ID", "request": { "name": "Get cart information by ID", @@ -490,7 +490,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "08f18ddf-ea0e-487d-854b-e638343df2c5", + "id": "72f2a3ed-4eb1-4cd3-ac2e-bba437af4327", "name": "OK", "originalRequest": { "url": { @@ -577,13 +577,13 @@ { "listen": "test", "script": { - "id": "598a9a37-3fc8-4d87-a509-ca35d92aa2c9", + "id": "b15d3580-c212-45bb-8a6a-a3c5df5baf0a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -593,7 +593,7 @@ } }, { - "id": "2630e494-0feb-4aa5-8cdd-adc4d6184f79", + "id": "866d5e79-d528-4d14-a466-9f4665c8f720", "name": "Remove all items from shopping cart", "request": { "name": "Remove all items from shopping cart", @@ -683,7 +683,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "72f2a12d-ea9e-4025-b7e2-3ff3787c4a11", + "id": "33b5eeda-052f-4c05-aa69-8b7e016ac2d2", "name": "OK", "originalRequest": { "url": { @@ -776,13 +776,13 @@ { "listen": "test", "script": { - "id": "4c35dd9f-e9d6-4de3-966c-04350cd7d1df", + "id": "a69efd50-7506-405c-a05d-e7fb8567cf74", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/removeAll - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/removeAll - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/removeAll - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/removeAll - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/removeAll - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -792,7 +792,7 @@ } }, { - "id": "a2a6f24b-a427-4fb9-98e1-939fdadb38e4", + "id": "0a98785c-778a-4437-b24e-cd4e4e7c4244", "name": "Remove all personal data from shopping cart", "request": { "name": "Remove all personal data from shopping cart", @@ -865,7 +865,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ec6db848-6a2c-47ac-9af2-04bdd4b094a6", + "id": "ae9fb502-4698-4f73-8338-a994bf53d1c2", "name": "OK", "originalRequest": { "url": { @@ -941,7 +941,7 @@ { "listen": "test", "script": { - "id": "1f5f86f9-9aed-42c9-96b3-79ff1d249c8e", + "id": "ebaf7fe5-c54d-4b59-b4fd-430a695b3f87", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/checkout/changeToAnonymousUser/:orderFormId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -955,7 +955,7 @@ } }, { - "id": "113d0b98-13f6-42d3-ac52-bf8e95347b8c", + "id": "353f99b8-687b-4608-9216-cfd77e09f9b4", "name": "Update cart items", "request": { "name": "Update cart items", @@ -1054,7 +1054,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "418abdb8-983e-4634-9c4a-8ebbe043c35a", + "id": "4fb9e5e0-7cd5-4396-aead-b3bb35974ae2", "name": "OK", "originalRequest": { "url": { @@ -1156,13 +1156,13 @@ { "listen": "test", "script": { - "id": "14d1976f-b234-4471-8cb4-dbec1692c774", + "id": "447506f2-b170-4de4-b89b-ff2afb50c629", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/update - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/update - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/update - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/update - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items/update - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1172,7 +1172,7 @@ } }, { - "id": "16a78488-b1ea-4725-a813-5389449a6839", + "id": "5b85de6d-ce0f-4198-966f-d045b75b38fc", "name": "Add cart items", "request": { "name": "Add cart items", @@ -1270,7 +1270,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "901cbe55-307a-4f02-8d75-146adb344090", + "id": "9d973125-9ef2-43bf-8352-6df54a4f9659", "name": "OK", "originalRequest": { "url": { @@ -1371,13 +1371,13 @@ { "listen": "test", "script": { - "id": "44f649c0-33c2-405a-a129-b2936baf6d86", + "id": "3ea77423-a38c-44d4-b2de-7918ff5cf318", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/items - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1387,7 +1387,7 @@ } }, { - "id": "b689ee3a-4f11-4a51-8001-1150aaca4c77", + "id": "51e92683-7e65-4541-b4d4-77194b03057d", "name": "Handle cart items", "request": { "name": "Handle cart items", @@ -1476,7 +1476,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7d066354-aa53-44fb-bb64-7d7fa4af1fed", + "id": "d48b77b5-839f-4f02-8aaf-dff42ddd0d14", "name": "OK", "originalRequest": { "url": { @@ -1568,13 +1568,13 @@ { "listen": "test", "script": { - "id": "49c3dcd0-76e3-4307-a1f7-acb3d8f355b9", + "id": "4e3b98fb-f129-4084-86bb-6210963045c6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/items - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/items - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/items - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/items - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/items - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1584,7 +1584,7 @@ } }, { - "id": "cebb7bcc-fe3a-4b7b-9077-164d4d48abe7", + "id": "bc2dfb91-55b6-40bd-a136-a98ebcaba342", "name": "Change price of an SKU in a cart", "request": { "name": "Change price of an SKU in a cart", @@ -1685,7 +1685,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "174f0bb9-a450-4898-beb4-671d9b05f405", + "id": "a8531791-bf3b-4056-af3e-5adc3803e24e", "name": "OK", "originalRequest": { "url": { @@ -1779,13 +1779,13 @@ { "listen": "test", "script": { - "id": "c2fd18e8-387b-4553-bb35-7175776b8d4f", + "id": "045d367b-a269-4bb9-8518-9e78670e4d03", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1795,7 +1795,7 @@ } }, { - "id": "aeed8199-fe57-4cf7-b269-1f7390f51244", + "id": "651e7c41-c479-41ae-a6d0-e34c94c5984d", "name": "Ignore profile data on checkout", "request": { "name": "Ignore profile data on checkout", @@ -1884,7 +1884,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "164cbcfe-ad50-4e09-a5b7-f9b620089eda", + "id": "20d0e451-857d-47c8-a2af-dfc0eaa17789", "name": "OK", "originalRequest": { "url": { @@ -1976,13 +1976,13 @@ { "listen": "test", "script": { - "id": "5ed3a951-1908-4132-ae42-300f7c6da4a0", + "id": "b49d38cc-9af1-467e-8f20-ef36084b89b9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/profile - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/profile - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/profile - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/profile - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PATCH]::/api/checkout/pub/orderForm/:orderFormId/profile - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1992,7 +1992,7 @@ } }, { - "id": "319be519-101e-4ecb-acf0-ab3c5781b996", + "id": "b4cd9306-b5e2-4b02-bec3-d2af6b6e469f", "name": "Cart installments", "request": { "name": "Cart installments", @@ -2077,7 +2077,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "dab6849f-7441-40aa-b722-8558f087e112", + "id": "b90320dd-dd87-42f6-8d94-a9601efa70ca", "name": "OK", "originalRequest": { "url": { @@ -2165,7 +2165,7 @@ { "listen": "test", "script": { - "id": "2322a971-e208-4a2e-884c-bf8727789578", + "id": "86240a43-e82d-4761-b8b1-eeaa505ccaee", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/orderForm/:orderFormId/installments - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2181,7 +2181,7 @@ } }, { - "id": "81ed6920-d772-4b33-9d31-d14c21d1a392", + "id": "7712b1ef-93c4-4ebc-a263-8dd26d8a6cf2", "name": "Add coupons to the cart", "request": { "name": "Add coupons to the cart", @@ -2270,7 +2270,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "95ab627c-aadd-4839-9b2f-32aad98af4a6", + "id": "fc5673f5-c11e-429b-acb8-87e5884ad780", "name": "OK", "originalRequest": { "url": { @@ -2362,13 +2362,13 @@ { "listen": "test", "script": { - "id": "84d7e3fb-fcb4-404f-bf9a-d86cf28e0bde", + "id": "f2ab2c28-144a-4a18-b5df-842036679647", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/coupons - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/coupons - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/coupons - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst 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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Available account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment information.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"type\":\"object\",\"description\":\"Delivery ID information.\",\"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\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\",\"type\":\"boolean\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"type\":\"object\",\"description\":\"Selected 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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"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\",\"null\"],\"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.\"},\"utmSource\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"description\":\"Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).\"},\"invoiceData\":{\"type\":\"object\",\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/coupons - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst 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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Available account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"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\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment information.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"type\":\"object\",\"description\":\"Delivery ID information.\",\"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\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\",\"type\":\"boolean\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"type\":\"object\",\"description\":\"Selected 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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"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\",\"null\"],\"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.\"},\"utmSource\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"description\":\"Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).\"},\"invoiceData\":{\"type\":\"object\",\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/coupons - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2381,7 +2381,7 @@ "event": [] }, { - "id": "9878918a-2b1a-46b9-9302-96935a85dcc5", + "id": "da51eb6a-9246-4db4-b93d-91f908e879e6", "name": "Cart attachments", "description": { "content": "", @@ -2389,7 +2389,7 @@ }, "item": [ { - "id": "32222922-3d4b-4c55-925b-823ee5ad4fb8", + "id": "449a298f-088c-44d3-a2c8-d1b27c3ec5b8", "name": "Get client profile by email", "request": { "name": "Get client profile by email", @@ -2470,7 +2470,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2762e95c-bc71-45a4-b94c-9f944f74abba", + "id": "7d924589-b118-4dde-b1be-d098851603e7", "name": "OK", "originalRequest": { "url": { @@ -2565,13 +2565,13 @@ { "listen": "test", "script": { - "id": "562e5c3c-aad8-48ad-bcb8-774fcc34b085", + "id": "ca0f542c-a358-498b-ae5c-5f2bcc5efd78", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/profiles - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/checkout/pub/profiles - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/checkout/pub/profiles - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account name.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"type\":\"object\",\"description\":\"Address information.\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userProfile\":{\"type\":\"object\",\"description\":\"Customer profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Document type.\"},\"phone\":{\"type\":\"string\",\"description\":\"Telephone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the company. Used for corporate clients.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name. Used for corporate clients.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Document. Used for corporate clients.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription. Used for corporate clients.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Telephone number. Used for corporate clients.\"},\"isCorporate\":{\"type\":\"boolean\",\"description\":\"Indicates whether the client is corporate.\"},\"profileCompleteOnLoading\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Profile complete when loading.\"},\"profileErrorOnLoading\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Profile error when loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"isComplete\":{\"type\":\"boolean\",\"description\":\"Indicates whether customer profile is complete.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/profiles - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account name.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"type\":\"object\",\"description\":\"Address information.\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"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\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userProfile\":{\"type\":\"object\",\"description\":\"Customer profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"document\":{\"type\":\"string\",\"description\":\"Document.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Document type.\"},\"phone\":{\"type\":\"string\",\"description\":\"Telephone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the company. Used for corporate clients.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name. Used for corporate clients.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Document. Used for corporate clients.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription. Used for corporate clients.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Telephone number. Used for corporate clients.\"},\"isCorporate\":{\"type\":\"boolean\",\"description\":\"Indicates whether the client is corporate.\"},\"profileCompleteOnLoading\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Profile complete when loading.\"},\"profileErrorOnLoading\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Profile error when loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"isComplete\":{\"type\":\"boolean\",\"description\":\"Indicates whether customer profile is complete.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/profiles - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2581,7 +2581,7 @@ } }, { - "id": "1bba7375-5dc3-4da5-be72-af37b6ab5dc1", + "id": "cdeff06d-59a2-496d-adeb-36ed17cc799b", "name": "Add client profile", "request": { "name": "Add client profile", @@ -2671,7 +2671,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "db5b18af-701a-4b12-84bf-d6d32d2c5d39", + "id": "ce5d5dc4-bca7-4332-a482-2fa9d3da7794", "name": "OK", "originalRequest": { "url": { @@ -2764,13 +2764,13 @@ { "listen": "test", "script": { - "id": "755fc351-06d6-41f5-8aa1-8161c32c0f44", + "id": "fbdc04c1-72b3-4548-914d-ea6528527591", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2780,12 +2780,12 @@ } }, { - "id": "5bf92dda-428e-41a0-8744-49fc902f2d5b", + "id": "3abf75c7-5b32-40e8-a0e4-9ddc454e2d75", "name": "Add shipping address and select delivery option", "request": { "name": "Add shipping address and select delivery option", "description": { - "content": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r>ℹ️ This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request.\r\n\r\nIf no `selectedSla` is sent in the request body, the API will automatically select the best delivery option among the ones available in the `slas` array, excluding pickup options and scheduled delivery options. If no such option is available, none will be selected.\r\n\r\nThe best delivery option selected is the one that can fulfill the biggest item quantity for the lowest price. This selection does not consider delivery time.\r\n\r\nThis process happens after the White Label Sellers selection in the Checkout pipeline. White label sellers selection is a separate process and is the responsibility of the Order Allocation module. For more information, see the [White label sellers selection](https://help.vtex.com/en/docs/tutorials/white-label-sellers-selection) article.\r\n\r\nFor a pickup option or a scheduled delivery option to be selected, it must be explicitly sent in the request body in the `selectedSla` field.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2870,7 +2870,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0fa942f9-9074-4247-ae74-d43819fb6ff0", + "id": "924f98cc-1a70-4ce0-ad0f-338951444fff", "name": "OK", "originalRequest": { "url": { @@ -2963,13 +2963,13 @@ { "listen": "test", "script": { - "id": "ee4b3f27-8502-41c2-a25a-38585862fe6e", + "id": "b2c52a2e-7a74-436a-a91b-a237e37868ab", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2979,7 +2979,7 @@ } }, { - "id": "c21b255e-2a52-4de4-ac79-22798f18c046", + "id": "2234c70e-84ef-44b1-9b66-a3d0d270ac54", "name": "Add client preferences", "request": { "name": "Add client preferences", @@ -3069,7 +3069,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "69cba5b6-4b36-4be7-b1e2-2a05d9669149", + "id": "9bfeb664-e565-4a8d-b78b-78f5d3f5fbfc", "name": "OK", "originalRequest": { "url": { @@ -3162,13 +3162,13 @@ { "listen": "test", "script": { - "id": "3b910af1-e59b-4f5f-a54d-8f15247e101a", + "id": "7bc9559d-6751-4fbf-90e6-9bb7ee79423d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3178,7 +3178,7 @@ } }, { - "id": "5ff9187b-7f3e-4da3-a53a-1894e11219f5", + "id": "19f30085-8136-496a-95e2-04f6d40e8b40", "name": "Add marketing data", "request": { "name": "Add marketing data", @@ -3268,7 +3268,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9c499376-7cc2-4d61-8e1d-52a44cede298", + "id": "d7881dbf-8ee0-483d-a92b-798f9d77f8d0", "name": "OK", "originalRequest": { "url": { @@ -3361,13 +3361,13 @@ { "listen": "test", "script": { - "id": "313a16c0-9a7d-4b55-8acf-01f799e79c82", + "id": "0df014a4-47e0-4342-8820-b2c14aeddab2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3377,7 +3377,7 @@ } }, { - "id": "5be4558b-7258-4942-b2a2-89c83d524362", + "id": "f6a36122-65c3-4442-a61b-28567588ad0b", "name": "Add payment data", "request": { "name": "Add payment data", @@ -3467,7 +3467,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "654a54f5-e783-4aa5-ad73-39badeddda21", + "id": "011c41a9-1ca2-480f-aefa-78926cb26b04", "name": "OK", "originalRequest": { "url": { @@ -3560,13 +3560,13 @@ { "listen": "test", "script": { - "id": "c7217c65-727f-4c03-b969-1d7ec442ad3d", + "id": "6e4c45e5-728a-482f-8883-7dcdbc5c6056", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3576,7 +3576,7 @@ } }, { - "id": "aa6e37ca-4fd2-4768-8ab1-9cd4069498c5", + "id": "e71f5d4c-2c4e-409a-9d01-171a9144a26c", "name": "Add merchant context data", "request": { "name": "Add merchant context data", @@ -3666,7 +3666,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "436889c6-09de-435d-b460-3ede93f0f83c", + "id": "35739d7b-3cf0-4ef4-9f97-a66cbda2d00d", "name": "OK", "originalRequest": { "url": { @@ -3759,7 +3759,7 @@ { "listen": "test", "script": { - "id": "975fe981-e341-4f6b-94cb-7b33ebdcc43c", + "id": "f9e94e84-466c-4e03-af3e-5eb4407ba27d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3775,7 +3775,7 @@ } }, { - "id": "14b81d45-7f4c-4df3-a80d-c92ec1afe300", + "id": "a5e94aa1-fe34-4d72-a708-3950c28481d8", "name": "Attach invoice data", "request": { "name": "Attach invoice data", @@ -3855,7 +3855,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e9b47cde-aaa2-4e20-9ba6-a2f3e78745d9", + "id": "93674c12-48bb-4c75-be44-2bf38b4fff79", "name": "OK", "originalRequest": { "url": { @@ -3938,13 +3938,13 @@ { "listen": "test", "script": { - "id": "6ac7e8e0-9f5d-47c5-8ac7-4cbe83bf3b1a", + "id": "710cd59e-1060-4ac2-bf26-986d8b954400", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3957,7 +3957,7 @@ "event": [] }, { - "id": "13ed6cf4-0731-45fa-a7d9-f312d9704030", + "id": "b247ae8e-7b53-451c-8d88-99f6827ec678", "name": "Custom data", "description": { "content": "", @@ -3965,7 +3965,7 @@ }, "item": [ { - "id": "571c2f39-1094-405d-8b1c-f2173c169a07", + "id": "844b87d4-69ed-4731-b49c-e8dffe49c3e8", "name": "Set multiple custom field values", "request": { "name": "Set multiple custom field values", @@ -4065,7 +4065,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0e3bd050-6224-462c-8073-a911cb902d08", + "id": "5f970995-ad0a-4a68-ba60-3d918fa81e7d", "name": "OK", "originalRequest": { "url": { @@ -4158,13 +4158,13 @@ { "listen": "test", "script": { - "id": "e61ddb94-1ee1-498a-99c5-fe370e6cfb08", + "id": "e5c50619-f977-4960-9597-427325c4763a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4174,7 +4174,7 @@ } }, { - "id": "88188dbb-cee4-44d7-901b-03d801e6e135", + "id": "108a848d-0343-430f-a736-72f6ce78e034", "name": "Set single custom field value", "request": { "name": "Set single custom field value", @@ -4285,7 +4285,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "132496b0-5ffd-411e-8e3d-4b01bd530408", + "id": "9d085186-aedb-461a-b351-043461ba3e90", "name": "OK", "originalRequest": { "url": { @@ -4379,13 +4379,13 @@ { "listen": "test", "script": { - "id": "d0c95fef-fc7e-49b6-b42e-186ecb42e642", + "id": "524fb4ca-badd-4915-bcb9-422ffe2eca41", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4395,7 +4395,7 @@ } }, { - "id": "ac98bdcc-cdd4-40f4-975c-3930cd45e577", + "id": "2384d5a3-7734-43fc-883f-cf8b6dab988d", "name": "Remove single custom field value", "request": { "name": "Remove single custom field value", @@ -4493,7 +4493,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "97118b8e-6b7c-44d8-a620-7ced5832cdfc", + "id": "3bccd553-a069-472e-b1f9-38ce463d72b3", "name": "OK", "originalRequest": { "url": { @@ -4574,13 +4574,13 @@ { "listen": "test", "script": { - "id": "124465ed-f1b1-4475-b8bf-baac978e2a23", + "id": "687d7458-f114-4220-a09c-fcc957f567ca", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4590,7 +4590,7 @@ } }, { - "id": "3ae88e0f-daf9-4047-bd03-4a1e28bff644", + "id": "79d69ae3-def6-430e-9e83-5ce42b7bf5c6", "name": "Batch add custom fields", "request": { "name": "Batch add custom fields", @@ -4679,7 +4679,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4ce79e0e-5dfe-4904-b410-c0ff387c6b80", + "id": "bb463e7c-5a54-44bc-aa5e-3028632b141f", "name": "OK", "originalRequest": { "url": { @@ -4771,13 +4771,13 @@ { "listen": "test", "script": { - "id": "b1e9fde3-35df-4564-9352-0763fd86d139", + "id": "f4099f41-4091-4d36-8a5c-b1e01becba37", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4787,7 +4787,7 @@ } }, { - "id": "65b25025-1de5-49e4-9335-7af7bda57207", + "id": "39879514-9db7-4c46-88a2-324c4a3e06b1", "name": "Add order custom field", "request": { "name": "Add order custom field", @@ -4877,7 +4877,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "70fa9797-4e41-48f5-8b10-3b1402be23e4", + "id": "2dd100c1-a789-4b2d-a3b1-049d9b3f2919", "name": "OK", "originalRequest": { "url": { @@ -4970,13 +4970,13 @@ { "listen": "test", "script": { - "id": "49b55d71-fdd6-4dea-8570-591239b2f734", + "id": "f554364c-91dc-4793-9c1b-a3294ef80cb9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/order - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/order - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/order - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/order - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/order - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4986,7 +4986,7 @@ } }, { - "id": "a5a4f9be-4b4a-4d55-87ee-1c8a072888da", + "id": "8dd415f1-dda3-481e-b7ee-2aef1fa869c7", "name": "Add item custom field", "request": { "name": "Add item custom field", @@ -5087,7 +5087,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5aa12cc9-1e2c-4a60-86a8-d92df7d613ff", + "id": "61d7fa7f-ddb6-4a24-b899-a09a5609fde4", "name": "OK", "originalRequest": { "url": { @@ -5181,13 +5181,13 @@ { "listen": "test", "script": { - "id": "c6abccae-5c0d-4e36-b231-e4038015dea3", + "id": "17806980-cf29-4dd5-af63-16f1527ea447", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5197,7 +5197,7 @@ } }, { - "id": "0272c471-ab03-4def-a009-533a3dbc1022", + "id": "a0683143-62e7-4c10-8f46-2789920cfdbc", "name": "Remove item custom field", "request": { "name": "Remove item custom field", @@ -5295,7 +5295,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e8a5e6bf-4ed6-4fe5-a6c7-6f185ecd3387", + "id": "86efd868-12b2-40cd-bf15-1b3073b42374", "name": "OK", "originalRequest": { "url": { @@ -5376,13 +5376,13 @@ { "listen": "test", "script": { - "id": "c8ef8174-20a6-45d5-9177-a43fbab134d6", + "id": "6eca0f33-6083-49a2-ba8d-e90134087d3b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/checkout/pub/orderForm/:orderFormId/customFields/item/:itemId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5392,7 +5392,7 @@ } }, { - "id": "49098716-6420-4c07-b211-72b098d91ab3", + "id": "5704d2fb-cd82-49ad-8442-1f69465091d9", "name": "Add address custom field", "request": { "name": "Add address custom field", @@ -5493,7 +5493,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "01861973-37c4-4139-b108-289fb160cdc9", + "id": "0861506f-4786-4d24-aeda-454eebf1e82a", "name": "OK", "originalRequest": { "url": { @@ -5587,13 +5587,13 @@ { "listen": "test", "script": { - "id": "2466ca97-8874-4b75-a0e1-6f91e15fb467", + "id": "ce5f0d65-f577-4c75-8843-9054362dd553", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/address/:addressId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/address/:addressId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/address/:addressId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/address/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orderForm/:orderFormId/customFields/address/:addressId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -5606,7 +5606,7 @@ "event": [] }, { - "id": "42268926-b7dd-4e46-88b0-4c52c6c6312e", + "id": "69a95cd7-ee00-4c66-a869-8a0376d79f14", "name": "Configuration", "description": { "content": "", @@ -5614,7 +5614,7 @@ }, "item": [ { - "id": "2c998b0b-36ac-457f-a1fd-894c81957994", + "id": "86f99481-eb98-4d3b-9ba8-e3cd24e19fd3", "name": "Get order form configuration", "request": { "name": "Get order form configuration", @@ -5678,7 +5678,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "93d20d9f-e84e-4c96-aa63-72da5e9380f1", + "id": "061932e1-eee2-4866-9d0a-793aeedace32", "name": "OK", "originalRequest": { "url": { @@ -5756,7 +5756,7 @@ { "listen": "test", "script": { - "id": "4e67750a-36d6-4e8d-8411-cc49f17a05dd", + "id": "44aa5355-1fa1-4bc8-9f5d-03d5bb8760c6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pvt/configuration/orderForm - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5772,7 +5772,7 @@ } }, { - "id": "94b1b1ff-b589-4f7b-b010-508a93e2aa19", + "id": "7667cf99-9efb-4342-85c0-63e1b01188d6", "name": "Update order form configuration", "request": { "name": "Update order form configuration", @@ -5845,7 +5845,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f27bf790-99f9-4de1-b4bd-93bbe8bcf942", + "id": "154ef39e-dee8-460f-bdd5-9884d7b11cf4", "name": "No Content", "originalRequest": { "url": { @@ -5926,7 +5926,7 @@ { "listen": "test", "script": { - "id": "5de5fc6a-ce42-4e61-899b-804854758543", + "id": "eb4139db-4389-4837-9032-b12f5140661c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pvt/configuration/orderForm - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5940,7 +5940,7 @@ } }, { - "id": "7e674b9d-8a39-498d-b177-4bfa200b9f0b", + "id": "24a28159-f653-4458-b175-39519bbd8baf", "name": "Get window to change seller", "request": { "name": "Get window to change seller", @@ -6004,7 +6004,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "5afe14ed-4d22-4a78-8453-a9a230b3d625", + "id": "cbdaa5df-2e8e-450a-976f-996769b3fda6", "name": "OK", "originalRequest": { "url": { @@ -6082,7 +6082,7 @@ { "listen": "test", "script": { - "id": "38306de0-d934-47d6-8cc9-25bf452ce07d", + "id": "0591e618-c5a3-400b-959d-7b9ba4ca1fd9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6096,7 +6096,7 @@ } }, { - "id": "2452e659-0ffd-403f-9cb4-8a9e065bf26d", + "id": "ef69fc9a-efc2-40f5-b8fb-6e0ebc8abb57", "name": "Update window to change seller", "request": { "name": "Update window to change seller", @@ -6169,7 +6169,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b3ffdbc3-ebdf-46bc-b132-e597b6fb4e43", + "id": "3bfc5f35-028c-4adb-8127-130cff4908e5", "name": "Created", "originalRequest": { "url": { @@ -6250,7 +6250,7 @@ { "listen": "test", "script": { - "id": "94a234a5-44f9-491c-a80e-d7f41067c247", + "id": "096e19e3-3f1e-479d-b998-937f7f1246fb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6263,7 +6263,7 @@ } }, { - "id": "74ab39d0-af40-4379-9d28-6edd8be9ad7f", + "id": "d5192fb6-a8ba-449f-98bd-d268364da56c", "name": "Clear order form messages", "request": { "name": "Clear order form messages", @@ -6353,7 +6353,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ab789739-4c58-4f9e-9b13-75d62f4575de", + "id": "310aca93-5c79-4d63-a5a5-0cedcb2ef639", "name": "OK", "originalRequest": { "url": { @@ -6446,13 +6446,13 @@ { "listen": "test", "script": { - "id": "59ec48d6-0614-4976-9bc2-064e460bffd6", + "id": "c114abe8-c4e0-44b6-b981-1a39fbc5ad01", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/messages/clear - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/messages/clear - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/messages/clear - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst 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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Available account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment information.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, Three business days will be represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":[\"string\",\"null\"],\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"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\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing information pertinent to the order's invoice.\"},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"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\":{\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/messages/clear - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst 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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Available account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"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\",\"null\"],\"description\":\"Complement to the address.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment information.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, Three business days will be represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":[\"string\",\"null\"],\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"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\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing information pertinent to the order's invoice.\"},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\"},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"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\":{\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/messages/clear - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -6465,7 +6465,7 @@ "event": [] }, { - "id": "3efeccfe-9d18-4aa4-9afc-74a4e1acfd21", + "id": "205ea005-0748-4459-8694-28f1827076aa", "name": "Fulfillment", "description": { "content": "", @@ -6473,7 +6473,7 @@ }, "item": [ { - "id": "55cf6838-6227-450e-97b0-89b820646aaa", + "id": "fe18a746-b1fc-48ec-b8b8-eba5fb11415e", "name": "List pickup points by location", "request": { "name": "List pickup points by location", @@ -6563,7 +6563,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "438111a0-f563-4f73-a11a-e2da3d120b75", + "id": "307a6077-53d7-4a6b-b6ec-34835b293d4c", "name": "OK", "originalRequest": { "url": { @@ -6667,13 +6667,13 @@ { "listen": "test", "script": { - "id": "9fb03e97-6854-495b-bd52-d0911e0e848c", + "id": "3171c5bf-d1ca-4289-aaa5-e437025e4436", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/pickup-points - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/checkout/pub/pickup-points - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/checkout/pub/pickup-points - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"paging\":{\"description\":\"Paging.\",\"type\":\"object\",\"properties\":{\"page\":{\"description\":\"Page number.\",\"type\":\"integer\"},\"pageSize\":{\"description\":\"Page size.\",\"type\":\"integer\"},\"total\":{\"description\":\"Total pages.\",\"type\":\"integer\"},\"pages\":{\"description\":\"Pages.\",\"type\":\"integer\"}}},\"items\":{\"description\":\"Items.\",\"type\":\"array\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"distance\":{\"description\":\"Distance.\",\"type\":\"number\"},\"pickupPoint\":{\"description\":\"Pickup point.\",\"type\":\"object\",\"properties\":{\"friendlyName\":{\"description\":\"Friendly name.\",\"type\":\"string\"},\"address\":{\"description\":\"Address.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"description\":\"Address type.\",\"type\":\"string\"},\"receiverName\":{\"description\":\"Receiver name.\",\"type\":\"string\"},\"addressId\":{\"description\":\"Address ID.\",\"type\":[\"string\",\"null\"]},\"isDisposable\":{\"description\":\"Is disposable.\",\"type\":\"boolean\"},\"postalCode\":{\"description\":\"Postal code.\",\"type\":\"string\"},\"city\":{\"description\":\"City.\",\"type\":\"string\"},\"state\":{\"description\":\"State.\",\"type\":\"string\"},\"country\":{\"description\":\"Country.\",\"type\":\"string\"},\"street\":{\"description\":\"Street.\",\"type\":\"string\"},\"number\":{\"description\":\"Number.\",\"type\":\"string\"},\"neighborhood\":{\"description\":\"Neighborhood.\",\"type\":\"string\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"description\":\"Racao.\",\"type\":\"string\"},\"geoCoordinates\":{\"description\":\"Geo coordinates.\",\"type\":\"array\",\"items\":{\"description\":\"Geo coordinate.\",\"type\":\"integer\"}}}},\"additionalInfo\":{\"description\":\"Additional info.\",\"type\":\"string\"},\"id\":{\"description\":\"ID.\",\"type\":\"string\"},\"businessHours\":{\"description\":\"Array with business hours.\",\"type\":\"array\",\"items\":{\"description\":\"Business hours.\",\"type\":\"object\",\"properties\":{\"DayOfWeek\":{\"description\":\"Day of week.\",\"type\":\"integer\"},\"OpeningTime\":{\"description\":\"Opening time.\",\"type\":\"string\"},\"ClosingTime\":{\"description\":\"Closing time.\",\"type\":\"string\"}}}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/pickup-points - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"paging\":{\"description\":\"Paging.\",\"type\":\"object\",\"properties\":{\"page\":{\"description\":\"Page number.\",\"type\":\"integer\"},\"pageSize\":{\"description\":\"Page size.\",\"type\":\"integer\"},\"total\":{\"description\":\"Total pages.\",\"type\":\"integer\"},\"pages\":{\"description\":\"Pages.\",\"type\":\"integer\"}}},\"items\":{\"description\":\"Items.\",\"type\":\"array\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"distance\":{\"description\":\"Distance.\",\"type\":\"number\"},\"pickupPoint\":{\"description\":\"Pickup point.\",\"type\":\"object\",\"properties\":{\"friendlyName\":{\"description\":\"Friendly name.\",\"type\":\"string\"},\"address\":{\"description\":\"Address.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"description\":\"Address type.\",\"type\":\"string\"},\"receiverName\":{\"description\":\"Receiver name.\",\"type\":\"string\"},\"addressId\":{\"description\":\"Address ID.\",\"type\":[\"string\",\"null\"]},\"isDisposable\":{\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\",\"type\":\"boolean\"},\"postalCode\":{\"description\":\"Postal code.\",\"type\":\"string\"},\"city\":{\"description\":\"City.\",\"type\":\"string\"},\"state\":{\"description\":\"State.\",\"type\":\"string\"},\"country\":{\"description\":\"Country.\",\"type\":\"string\"},\"street\":{\"description\":\"Street.\",\"type\":\"string\"},\"number\":{\"description\":\"Number.\",\"type\":\"string\"},\"neighborhood\":{\"description\":\"Neighborhood.\",\"type\":\"string\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"description\":\"Racao.\",\"type\":\"string\"},\"geoCoordinates\":{\"description\":\"Geo coordinates.\",\"type\":\"array\",\"items\":{\"description\":\"Geo coordinate.\",\"type\":\"integer\"}}}},\"additionalInfo\":{\"description\":\"Additional info.\",\"type\":\"string\"},\"id\":{\"description\":\"ID.\",\"type\":\"string\"},\"businessHours\":{\"description\":\"Array with business hours.\",\"type\":\"array\",\"items\":{\"description\":\"Business hours.\",\"type\":\"object\",\"properties\":{\"DayOfWeek\":{\"description\":\"Day of week.\",\"type\":\"integer\"},\"OpeningTime\":{\"description\":\"Opening time.\",\"type\":\"string\"},\"ClosingTime\":{\"description\":\"Closing time.\",\"type\":\"string\"}}}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/checkout/pub/pickup-points - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -6683,7 +6683,7 @@ } }, { - "id": "d3cbd3e3-b8e1-41b4-ab58-363f2456ffe7", + "id": "ca7a48f5-ec82-4dc5-9330-650b795117cd", "name": "Get address by postal code", "request": { "name": "Get address by postal code", @@ -6769,7 +6769,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "65c917cc-1393-4d7d-875d-9abffe750164", + "id": "b49b8a4b-0dcb-4798-b2d8-b12e54789111", "name": "OK", "originalRequest": { "url": { @@ -6848,7 +6848,7 @@ { "listen": "test", "script": { - "id": "6752032c-ef34-4a07-9053-850e4c5cae13", + "id": "94c50cf7-0bfa-438f-b962-d3c5d5f51c17", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/postal-code/:countryCode/:postalCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6867,7 +6867,7 @@ "event": [] }, { - "id": "3ea01c30-c0da-4057-adc5-55dece76409a", + "id": "a8ebe23d-ca9c-46a7-bd53-3ee1f1ebb538", "name": "Order placement", "description": { "content": "", @@ -6875,7 +6875,7 @@ }, "item": [ { - "id": "ec9ea727-1836-4649-9dcc-ffa058a020bb", + "id": "9278dd20-10f6-41ce-89ab-abad1b9eb9ba", "name": "Place order from an existing cart", "request": { "name": "Place order from an existing cart", @@ -6964,7 +6964,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bc440151-8640-417e-8f3b-4517ed9bfa54", + "id": "ced4ce98-d49c-4e85-aefb-9164a8fb9a58", "name": "OK", "originalRequest": { "url": { @@ -7056,13 +7056,13 @@ { "listen": "test", "script": { - "id": "4071d8d7-67f5-4f01-8458-666c5fa2a097", + "id": "857ce737-455e-4836-b61b-8d1a2060ef50", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/transaction - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/transaction - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/transaction - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/transaction - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"OrderForm object containing cart and order information.\",\"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\",\"null\"],\"description\":\"ID of the store.\"},\"allowManualPrice\":{\"type\":\"boolean\",\"description\":\"Permission to modify item price manually.\"},\"canEditData\":{\"type\":\"boolean\",\"description\":\"Data can be edited.\"},\"userProfileId\":{\"type\":\"string\",\"description\":\"Unique ID associated with the customer profile.\"},\"profileProvider\":{\"type\":\"string\",\"description\":\"Profile provider.\"},\"availableAccounts\":{\"type\":\"array\",\"description\":\"Available accounts.\",\"items\":{\"type\":\"string\",\"description\":\"Account.\"}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Information on each available address.\",\"items\":{\"description\":\"Address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Address type.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the receiver.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the address.\"},\"country\":{\"type\":\"string\",\"description\":\"Country of the address. ISO three-letter code.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Reference that may help in the location of the address.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"userType\":{\"type\":[\"string\",\"null\"],\"description\":\"User type.\"},\"ignoreProfileData\":{\"type\":\"boolean\",\"description\":\"Ignore customer profile data.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.\"},\"messages\":{\"type\":\"array\",\"description\":\"Array containing an object for each message generated by our servers while processing the request.\",\"items\":{\"type\":\"string\",\"description\":\"Message.\"}},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"selectableGifts\":{\"type\":\"array\",\"description\":\"Array containing the data of the item selected as a gift.\",\"items\":{\"type\":\"string\",\"description\":\"Gift.\"}},\"totalizers\":{\"type\":\"array\",\"description\":\"Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).\",\"items\":{\"type\":\"object\",\"description\":\"Totalizer of purchases.\"}},\"shippingData\":{\"type\":[\"object\",\"null\"],\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"attachmentOfferings\":{\"type\":[\"array\",\"null\"],\"description\":\"List of attachments details.\",\"items\":{\"description\":\"Attachment details.\",\"type\":\"object\",\"required\":[\"name\",\"required\",\"schema\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the attachment.\"},\"required\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Defines if the attachment is required (`true`) or not (`false`).\"},\"schema\":{\"type\":[\"object\",\"null\"],\"description\":\"Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, \\\"three business days\\\" will be represented as `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that repesent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array with two strings that represent geocoordinates: first latitude, then longitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates.\"}}}}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":[\"object\",\"null\"],\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"string\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"marketingData\":{\"type\":[\"object\",\"null\"],\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source.\"},\"utmMedium\":{\"type\":\"string\",\"description\":\"UTM medium.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign.\"},\"utmiPage\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_page (internal utm).\"},\"utmiPart\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_part (internal utm).\"},\"utmiCampaign\":{\"type\":[\"string\",\"null\"],\"description\":\"utmi_campaign (internal utm).\"}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"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\",\"null\"],\"description\":\"`true` if the client opted to receive newsletter from the store.\"}}},\"commercialConditionData\":{\"type\":[\"object\",\"null\"],\"description\":\"Object containing commercial condition information.\"},\"storePreferencesData\":{\"type\":\"object\",\"description\":\"Object containing data from the store's configuration (stored in VTEX's License Manager).\"},\"giftRegistryData\":{\"type\":[\"object\",\"null\"],\"description\":\"Gift registry list information.\"},\"openTextField\":{\"type\":[\"string\",\"null\"],\"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).\"},\"invoiceData\":{\"type\":[\"object\",\"null\"],\"description\":\"Invoice data including billing address.\",\"properties\":{\"address\":{\"type\":\"object\",\"description\":\"Billing address.\",\"properties\":{\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City name.\"},\"state\":{\"type\":\"string\",\"description\":\"State name.\"},\"country\":{\"type\":\"string\",\"description\":\"Country.\"},\"street\":{\"type\":\"string\",\"description\":\"Street name.\"},\"number\":{\"type\":\"string\",\"description\":\"Street number.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood.\"},\"complement\":{\"type\":\"string\",\"description\":\"Address complement.\"},\"reference\":{\"type\":\"string\",\"description\":\"Reference for location.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Geographic coordinates (latitude, longitude).\",\"items\":{\"type\":\"number\",\"description\":\"Coordinate value.\"}}}}}},\"customData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer additional information.\",\"properties\":{\"customApps\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable apps created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable apps details.\"}},\"customFields\":{\"type\":[\"array\",\"null\"],\"description\":\"Customizable fields created by the store.\",\"items\":{\"type\":[\"object\",\"null\"],\"description\":\"Customizable fields details.\",\"properties\":{\"linkedEntity\":{\"type\":\"object\",\"description\":\"Linked entity.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Linked entity type.\",\"enum\":[\"order\",\"item\",\"address\"]},\"id\":{\"type\":\"string\",\"description\":\"Linked entity ID.\"}}},\"fields\":{\"type\":\"array\",\"description\":\"Custom fields.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields details.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"},\"refId\":{\"type\":\"string\",\"description\":\"Custom field reference ID.\"}}}}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"description\":\"Item metadata.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Item ID.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"hooksData\":{\"type\":[\"object\",\"null\"],\"description\":\"Hooks information.\"},\"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\",\"null\"],\"description\":\"Subscription information.\"},\"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.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/checkout/pub/orderForm/:orderFormId/transaction - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -7072,7 +7072,7 @@ } }, { - "id": "cb0c36ba-fa35-4d42-878a-0035a7398e62", + "id": "cc60b42d-b615-4432-83c8-6d2fe25a34e2", "name": "Place order", "request": { "name": "Place order", @@ -7157,7 +7157,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d9be8318-79f0-4583-a393-5976b0c8c6f4", + "id": "07b9ac03-fad3-4a85-b13c-98e5c90012a6", "name": "OK", "originalRequest": { "url": { @@ -7256,13 +7256,13 @@ { "listen": "test", "script": { - "id": "1deec092-21f0-4fc8-be09-bd5d62d37e96", + "id": "deb6cc69-4b9d-46f2-8edc-0230c5a2ea3d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/checkout/pub/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/checkout/pub/orders - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[PUT]::/api/checkout/pub/orders - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"orderForm\":{\"type\":[\"string\",\"null\"],\"description\":\"This is `null` since this request does not depend on any previously existing orderForm information in the platform.\"},\"transactionData\":{\"type\":\"object\",\"description\":\"Information on each transaction pertinent to the order placed.\",\"properties\":{\"merchantTransactions\":{\"type\":\"array\",\"description\":\"Information on each merchant transaction.\",\"items\":{\"description\":\"Merchant transaction information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the seller.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"ID of the transaction in the platform.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant responsible for the sale.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment pertinent to the transaction.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"paymentSystem\":{\"type\":\"integer\",\"description\":\"Payment system.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment bin.\"},\"accountId\":{\"type\":[\"string\",\"null\"],\"description\":\"Account ID.\"},\"tokenId\":{\"type\":[\"string\",\"null\"],\"description\":\"Token ID.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value to be paid in this payment.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value over which interests may be applied.\"},\"giftCardRedemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card redemption code.\"},\"giftCardProvider\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card provider.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"}}}}}}},\"receiverUri\":{\"type\":\"string\",\"description\":\"Receiver URI.\"},\"gatewayCallbackTemplatePath\":{\"type\":\"string\",\"description\":\"Template of the gateway callback path, which may later be used to send information about the transaction.\"}}},\"orders\":{\"type\":\"array\",\"description\":\"Information on each of the orders created.\",\"items\":{\"description\":\"Order information.\",\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\",\"description\":\"ID of the order in the Order Management System (OMS).\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Order group. Orders that involve different sellers are split into different orders of a same order group.\"},\"state\":{\"type\":[\"string\",\"null\"],\"description\":\"State.\"},\"isCheckedIn\":{\"type\":\"boolean\",\"description\":\"Indicates whether order is checked in.\"},\"sellerOrderId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the order in the seller.\"},\"storeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Store ID.\"},\"checkedInPickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Checked in pickup point.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value of the order.\"},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment ID.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"}}}},\"totals\":{\"type\":\"array\",\"description\":\"Information on order totals.\",\"items\":{\"description\":\"Order total information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Total ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Total name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value.\"}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"ratesAndBenefitsData\":{\"type\":\"object\",\"description\":\"Information on rates and benefits that apply to the order.\",\"properties\":{\"rateAndBenefitsIdentifiers\":{\"type\":\"array\",\"description\":\"List with rates and benefits identifiers.\",\"items\":{\"type\":\"string\",\"description\":\"Rate and benefit identifier.\"}},\"teaser\":{\"type\":\"array\",\"description\":\"List with rates and benefits teasers.\",\"items\":{\"type\":\"string\",\"description\":\"Rate and benefit teaser.\"}}}},\"shippingData\":{\"type\":\"object\",\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"SLA selected by the customer. If the store uses the [Delivery Option](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`.\"},\"selectedDeliveryChannel\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer. For example, `\\\"delivery\\\"` or `\\\"pickup-in-point\\\"`.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, Three business days will be represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"Indicates whether address is disposable.\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"integer\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"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\":{\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"salesChannel\":{\"type\":\"string\",\"description\":\"Sales channel.\"},\"followUpEmail\":{\"type\":\"string\",\"description\":\"Follow up email address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Creation date.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Last change.\"},\"timeZoneCreationDate\":{\"type\":\"string\",\"description\":\"Time zone creation date.\"},\"timeZoneLastChange\":{\"type\":\"string\",\"description\":\"Time zone last change.\"},\"isCompleted\":{\"type\":\"boolean\",\"description\":\"Indicates whether order is completed.\"},\"hostName\":{\"type\":\"string\",\"description\":\"Host name.\"},\"merchantName\":{\"type\":[\"string\",\"null\"],\"description\":\"Merchant name.\"},\"userType\":{\"type\":\"string\",\"description\":\"User type.\"},\"roundingError\":{\"type\":\"integer\",\"description\":\"Rounding error.\"},\"allowEdition\":{\"type\":\"boolean\",\"description\":\"Indicates whether edition is allowed.\"},\"allowCancelation\":{\"type\":\"boolean\",\"description\":\"Indicates whether cancelation is allowed.\"},\"allowChangeSeller\":{\"type\":\"boolean\",\"description\":\"Indicates whether seller changing is allowed.\"},\"isUserDataVisible\":{\"type\":\"boolean\",\"description\":\"Indicates whether user data is visible.\"},\"orderFormCreationDate\":{\"type\":\"string\",\"description\":\"`orderForm` creation date.\"},\"salesAssociateId\":{\"type\":\"string\",\"description\":\"Sales Associate (Seller) identification code.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orders - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"orderForm\":{\"type\":[\"string\",\"null\"],\"description\":\"This is `null` since this request does not depend on any previously existing orderForm information in the platform.\"},\"transactionData\":{\"type\":\"object\",\"description\":\"Information on each transaction pertinent to the order placed.\",\"properties\":{\"merchantTransactions\":{\"type\":\"array\",\"description\":\"Information on each merchant transaction.\",\"items\":{\"description\":\"Merchant transaction information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the seller.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"ID of the transaction in the platform.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Name of the merchant responsible for the sale.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment pertinent to the transaction.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"paymentSystem\":{\"type\":\"integer\",\"description\":\"Payment system.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Payment bin.\"},\"accountId\":{\"type\":[\"string\",\"null\"],\"description\":\"Account ID.\"},\"tokenId\":{\"type\":[\"string\",\"null\"],\"description\":\"Token ID.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value to be paid in this payment.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value over which interests may be applied.\"},\"giftCardRedemptionCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card redemption code.\"},\"giftCardProvider\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card provider.\"},\"giftCardId\":{\"type\":[\"string\",\"null\"],\"description\":\"Gift card ID.\"}}}}}}},\"receiverUri\":{\"type\":\"string\",\"description\":\"Receiver URI.\"},\"gatewayCallbackTemplatePath\":{\"type\":\"string\",\"description\":\"Template of the gateway callback path, which may later be used to send information about the transaction.\"}}},\"orders\":{\"type\":\"array\",\"description\":\"Information on each of the orders created.\",\"items\":{\"description\":\"Order information.\",\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\",\"description\":\"ID of the order in the Order Management System (OMS).\"},\"orderGroup\":{\"type\":\"string\",\"description\":\"Order group. Orders that involve different sellers are split into different orders of a same order group.\"},\"state\":{\"type\":[\"string\",\"null\"],\"description\":\"State.\"},\"isCheckedIn\":{\"type\":\"boolean\",\"description\":\"Indicates whether order is checked in.\"},\"sellerOrderId\":{\"type\":[\"string\",\"null\"],\"description\":\"ID of the order in the seller.\"},\"storeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Store ID.\"},\"checkedInPickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Checked in pickup point.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value of the order.\"},\"items\":{\"type\":\"array\",\"description\":\"Information on each item in the order.\",\"items\":{\"description\":\"Item information.\",\"type\":\"object\",\"properties\":{\"uniqueId\":{\"type\":\"string\",\"description\":\"Unique ID.\"},\"id\":{\"type\":\"string\",\"description\":\"ID of the item.\"},\"productId\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"productRefId\":{\"type\":\"string\",\"description\":\"Product Ref ID.\"},\"refId\":{\"type\":\"string\",\"description\":\"Ref ID.\"},\"ean\":{\"type\":[\"string\",\"null\"],\"description\":\"European Article Number.\"},\"name\":{\"type\":\"string\",\"description\":\"Product name.\"},\"skuName\":{\"type\":\"string\",\"description\":\"SKU name.\"},\"modalType\":{\"type\":[\"string\",\"null\"],\"description\":\"Modal type.\"},\"parentItemIndex\":{\"type\":[\"integer\",\"null\"],\"description\":\"Parent item index.\"},\"parentAssemblyBinding\":{\"type\":[\"string\",\"null\"],\"description\":\"Parent assembly binding.\"},\"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\",\"null\"],\"description\":\"Manual price in cents.\"},\"manualPriceAppliedBy\":{\"type\":[\"string\",\"null\"],\"description\":\"User that applied the manual price, if that is the case.\"},\"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\",\"null\"],\"description\":\"Dimension.\"},\"brandName\":{\"type\":\"string\",\"description\":\"Brand name.\"},\"brandId\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"offeringInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering information.\"},\"offeringType\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type.\"},\"offeringTypeId\":{\"type\":[\"string\",\"null\"],\"description\":\"Offering type ID.\"}}},\"preSaleDate\":{\"type\":[\"string\",\"null\"],\"description\":\"Presale date.\"},\"productCategoryIds\":{\"type\":\"string\",\"description\":\"Product category IDs.\"},\"productCategories\":{\"type\":\"object\",\"description\":\"Object, where each field is an ID from `productCategoryIds`.\",\"properties\":{\"{ID}\":{\"type\":\"string\",\"description\":\"Product category corresponding to the ID in the field key.\"}}},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"},\"seller\":{\"type\":\"string\",\"description\":\"Seller.\"},\"sellerChain\":{\"type\":\"array\",\"description\":\"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.\",\"items\":{\"type\":\"string\",\"description\":\"Seller.\"}},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"},\"bundleItems\":{\"type\":\"array\",\"description\":\"Information on services sold along with the SKU. Example: a gift package.\",\"items\":{\"description\":\"Service information.\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Service type.\"},\"id\":{\"type\":\"integer\",\"description\":\"Service identifier.\"},\"name\":{\"type\":\"string\",\"description\":\"Service name.\"},\"price\":{\"type\":\"integer\",\"description\":\"Service price in cents.\"}}}},\"attachments\":{\"type\":\"array\",\"description\":\"Array containing information on attachments.\",\"items\":{\"type\":\"string\",\"description\":\"Attachment ID.\"}},\"priceTags\":{\"type\":\"array\",\"description\":\"Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.\",\"items\":{\"description\":\"Price tag information.\",\"type\":\"object\",\"properties\":{\"identifier\":{\"type\":[\"string\",\"null\"],\"description\":\"Promotion unique identifier.\"},\"isPercentual\":{\"type\":\"boolean\",\"description\":\"Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.\"},\"name\":{\"type\":\"string\",\"description\":\"Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\\r\\n- `type` indicates whether the tag refers to a discount or tax.\\r\\n- `where` specifies the context, either price or shipping.\\r\\n- `identifier` is the promotion ID.\\r\\n- `calculationId` is a hash that may vary with each price calculation.\"},\"rawValue\":{\"type\":\"number\",\"description\":\"Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.\"},\"value\":{\"type\":\"integer\",\"description\":\"Price tag value representing either a promotion (value decrease) or a tax (value increase).\"}}}},\"availability\":{\"type\":\"string\",\"description\":\"Availability.\"},\"measurementUnit\":{\"type\":\"string\",\"description\":\"Measurement unit.\"},\"unitMultiplier\":{\"type\":\"integer\",\"description\":\"Unit multiplier.\"},\"manufacturerCode\":{\"type\":[\"string\",\"null\"],\"description\":\"Manufacturer code.\"},\"priceDefinition\":{\"type\":\"object\",\"description\":\"Price information for all units of a specific item.\",\"properties\":{\"calculatedSellingPrice\":{\"type\":\"integer\",\"description\":\"Item's calculated unitary selling price in cents.\"},\"total\":{\"type\":\"integer\",\"description\":\"Total value for all units of the item in cents.\"},\"sellingPrices\":{\"type\":\"array\",\"description\":\"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.\",\"items\":{\"description\":\"Rounding information.\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"description\":\"Value in cents for that specific rounding.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Rounding quantity, meaning how many items are rounded to this value.\"}}}}}}}}},\"sellers\":{\"type\":\"array\",\"description\":\"Information on each seller.\",\"items\":{\"description\":\"Seller information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Seller ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Seller name.\"},\"logo\":{\"type\":[\"string\",\"null\"],\"description\":\"Seller logo.\"},\"minimumOrderValue\":{\"type\":[\"integer\",\"null\"],\"description\":\"Minimum order value configured at the seller, in cents.\"}}}},\"totals\":{\"type\":\"array\",\"description\":\"Information on order totals.\",\"items\":{\"description\":\"Order total information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Total ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Total name.\"},\"value\":{\"type\":\"integer\",\"description\":\"Total value.\"}}}},\"clientProfileData\":{\"type\":[\"object\",\"null\"],\"description\":\"Customer's profile information.\",\"properties\":{\"email\":{\"type\":[\"string\",\"null\"],\"description\":\"Email address.\"},\"firstName\":{\"type\":[\"string\",\"null\"],\"description\":\"First name.\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Type of the document informed by the customer.\"},\"document\":{\"type\":\"string\",\"description\":\"Document informed by the customer.\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number.\"},\"corporateName\":{\"type\":[\"string\",\"null\"],\"description\":\"Company name, if the customer is a legal entity.\"},\"tradeName\":{\"type\":[\"string\",\"null\"],\"description\":\"Trade name, if the customer is a legal entity.\"},\"corporateDocument\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate document, if the customer is a legal entity.\"},\"stateInscription\":{\"type\":[\"string\",\"null\"],\"description\":\"State inscription, if the customer is a legal entity.\"},\"corporatePhone\":{\"type\":[\"string\",\"null\"],\"description\":\"Corporate phone number, if the customer is a legal entity.\"},\"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\",\"null\"],\"description\":\"Indicates whether profile presents error on loading.\"},\"customerClass\":{\"type\":[\"string\",\"null\"],\"description\":\"Customer class.\"}}},\"ratesAndBenefitsData\":{\"type\":\"object\",\"description\":\"Information on rates and benefits that apply to the order.\",\"properties\":{\"rateAndBenefitsIdentifiers\":{\"type\":\"array\",\"description\":\"List with rates and benefits identifiers.\",\"items\":{\"type\":\"string\",\"description\":\"Rate and benefit identifier.\"}},\"teaser\":{\"type\":\"array\",\"description\":\"List with rates and benefits teasers.\",\"items\":{\"type\":\"string\",\"description\":\"Rate and benefit teaser.\"}}}},\"shippingData\":{\"type\":\"object\",\"description\":\"Shipping information pertinent to the order.\",\"properties\":{\"address\":{\"type\":[\"object\",\"null\"],\"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\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"logisticsInfo\":{\"type\":\"array\",\"description\":\"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.\",\"items\":{\"description\":\"Logistics information.\",\"type\":\"object\",\"properties\":{\"itemIndex\":{\"type\":\"integer\",\"description\":\"Index corresponding to the position of the object in the `items` array.\"},\"selectedSla\":{\"type\":[\"string\",\"null\"],\"description\":\"Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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\":{\"type\":[\"string\",\"null\"],\"description\":\"Delivery channel selected by the customer. For example, `\\\"delivery\\\"` or `\\\"pickup-in-point\\\"`.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"slas\":{\"type\":\"array\",\"description\":\"Information on available SLAs.\",\"items\":{\"description\":\"SLA information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SLA ID. If the store uses the [Delivery Option](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\":{\"type\":\"string\",\"description\":\"Delivery channel.\"},\"name\":{\"type\":\"string\",\"description\":\"SLA name. If the store uses the [Delivery Option](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\":{\"type\":\"array\",\"description\":\"Information on each delivery ID.\",\"items\":{\"description\":\"Delivery ID information.\",\"type\":\"object\",\"properties\":{\"courierId\":{\"type\":\"string\",\"description\":\"Courier ID.\"},\"warehouseId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"dockId\":{\"type\":\"string\",\"description\":\"Warehouse ID.\"},\"courierName\":{\"type\":\"string\",\"description\":\"Courier name.\"},\"quantity\":{\"type\":\"integer\",\"description\":\"Quantity.\"}}}},\"shippingEstimate\":{\"type\":\"string\",\"description\":\"Shipping estimate. For instance, Three business days will be represented `3bd`.\"},\"shippingEstimateDate\":{\"type\":[\"string\",\"null\"],\"description\":\"When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.\"},\"useIndividualShippingEstimates\":{\"type\":\"boolean\",\"description\":\"Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.\"},\"lockTTL\":{\"type\":[\"string\",\"null\"],\"description\":\"Estimate date of delivery.\"},\"price\":{\"type\":\"integer\",\"description\":\"Price in cents.\"},\"listPrice\":{\"type\":\"integer\",\"description\":\"List price in cents.\"},\"tax\":{\"type\":\"integer\",\"description\":\"Tax in cents.\"},\"pickupStoreInfo\":{\"type\":\"object\",\"description\":\"Information on the pickup store.\",\"properties\":{\"isPickupStore\":{\"type\":\"boolean\",\"description\":\"Indicates whether it is the pickup store.\"},\"friendlyName\":{\"type\":[\"string\",\"null\"],\"description\":\"Friendly name.\"},\"address\":{\"type\":[\"object\",\"null\"],\"description\":\"Address information.\",\"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\",\"null\"],\"description\":\"Complement to the shipping address, in case it applies.\"},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}},\"additionalInfo\":{\"type\":[\"string\",\"null\"],\"description\":\"Additional information.\"},\"dockId\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponding dock ID.\"}}},\"pickupPointId\":{\"type\":[\"string\",\"null\"],\"description\":\"Pickup point ID.\"},\"pickupDistance\":{\"type\":\"integer\",\"description\":\"Pickup point distance.\"},\"polygonName\":{\"type\":[\"string\",\"null\"],\"description\":\"Polygon name.\"},\"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\":\"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\":{\"type\":\"array\",\"description\":\"List of available delivery channels.\",\"items\":{\"description\":\"Delivery channel information.\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Delivery channel ID.\"}}}}}}},\"selectedAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the selected addresses for the order.\",\"items\":{\"description\":\"Selected address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}},\"availableAddresses\":{\"type\":\"array\",\"description\":\"Array with information on the available addresses for the order.\",\"items\":{\"description\":\"Available address information.\",\"type\":\"object\",\"properties\":{\"addressType\":{\"type\":\"string\",\"description\":\"Type of address. For example, `Residential` or `Pickup`.\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the person who is going to receive the order.\"},\"addressId\":{\"type\":[\"string\",\"null\"],\"description\":\"Address ID.\"},\"isDisposable\":{\"type\":\"boolean\",\"description\":\"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.\\r\\n\\r\\nBehavior by address type:\\r\\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\\r\\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\\r\\n- `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.\\r\\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\\r\\n\\r\\nWhen 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\":{\"type\":\"string\",\"description\":\"Postal code.\"},\"city\":{\"type\":\"string\",\"description\":\"City of the shipping address.\"},\"state\":{\"type\":\"string\",\"description\":\"State of the shipping address.\"},\"country\":{\"type\":\"string\",\"description\":\"Three letter ISO code of the country of the shipping address.\"},\"street\":{\"type\":\"string\",\"description\":\"Street of the shipping address.\"},\"number\":{\"type\":\"string\",\"description\":\"Number of the building, house or apartment in the shipping address.\"},\"neighborhood\":{\"type\":\"string\",\"description\":\"Neighborhood of the shipping address.\"},\"complement\":{\"description\":\"Complement to the shipping address, in case it applies.\",\"type\":[\"string\",\"null\"]},\"reference\":{\"type\":[\"string\",\"null\"],\"description\":\"Complement that might help locate the shipping address more precisely in case of delivery.\"},\"geoCoordinates\":{\"type\":\"array\",\"description\":\"Array containing two floats with geocoordinates, first longitude, then latitude.\",\"items\":{\"type\":\"number\",\"description\":\"Geocoordinates numbers.\"}}}}}}},\"paymentData\":{\"type\":\"object\",\"description\":\"Information on the order's payment.\",\"properties\":{\"giftCards\":{\"type\":\"array\",\"description\":\"Gift card information, if it applies to the order.\",\"items\":{\"description\":\"Gift card information.\",\"type\":\"object\",\"properties\":{\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card redemption code.\"},\"value\":{\"type\":\"integer\",\"description\":\"Gift card value in cents.\"},\"balance\":{\"type\":\"integer\",\"description\":\"Gift card balance in cents.\"},\"name\":{\"type\":\"string\",\"description\":\"Gift card name.\"},\"id\":{\"type\":\"string\",\"description\":\"Gift card ID.\"},\"inUse\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is in use.\"},\"isSpecialCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether gift card is special.\"}}}},\"transactions\":{\"type\":\"array\",\"description\":\"Information on each transaction pertinent to the order.\",\"items\":{\"description\":\"Transaction information.\",\"type\":\"object\",\"properties\":{\"isActive\":{\"type\":\"boolean\",\"description\":\"Indicates whether transaction is active.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Transaction ID.\"},\"merchantName\":{\"type\":\"string\",\"description\":\"Merchant name.\"},\"payments\":{\"type\":\"array\",\"description\":\"Information on each payment.\",\"items\":{\"description\":\"Payment information.\",\"type\":\"object\",\"properties\":{\"accountId\":{\"type\":\"string\",\"description\":\"Account ID.\"},\"bin\":{\"type\":[\"string\",\"null\"],\"description\":\"Bin.\"},\"installments\":{\"type\":\"integer\",\"description\":\"Number of installments.\"},\"paymentSystem\":{\"type\":\"integer\",\"description\":\"Payment system.\"},\"referenceValue\":{\"type\":\"integer\",\"description\":\"Reference value for calculating interest rates, in case it applies. Displayed in cents.\"},\"value\":{\"type\":\"integer\",\"description\":\"Value including interest, in case it applies. Displayed in cents.\"}}}},\"sharedTransaction\":{\"type\":\"boolean\",\"description\":\"Indicates whather transaction is shared.\"}}}}}},\"itemMetadata\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"List of objects containing metadata on each item in the order.\",\"items\":{\"type\":\"object\",\"description\":\"Item metadata.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"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\":{\"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\",\"null\"],\"description\":\"European Article Number.\"},\"imageUrl\":{\"type\":\"string\",\"description\":\"Image URL.\"},\"detailUrl\":{\"type\":\"string\",\"description\":\"Detail URL.\"}}}}}},\"salesChannel\":{\"type\":\"string\",\"description\":\"Sales channel.\"},\"followUpEmail\":{\"type\":\"string\",\"description\":\"Follow up email address.\"},\"creationDate\":{\"type\":\"string\",\"description\":\"Creation date.\"},\"lastChange\":{\"type\":\"string\",\"description\":\"Last change.\"},\"timeZoneCreationDate\":{\"type\":\"string\",\"description\":\"Time zone creation date.\"},\"timeZoneLastChange\":{\"type\":\"string\",\"description\":\"Time zone last change.\"},\"isCompleted\":{\"type\":\"boolean\",\"description\":\"Indicates whether order is completed.\"},\"hostName\":{\"type\":\"string\",\"description\":\"Host name.\"},\"merchantName\":{\"type\":[\"string\",\"null\"],\"description\":\"Merchant name.\"},\"userType\":{\"type\":\"string\",\"description\":\"User type.\"},\"roundingError\":{\"type\":\"integer\",\"description\":\"Rounding error.\"},\"allowEdition\":{\"type\":\"boolean\",\"description\":\"Indicates whether edition is allowed.\"},\"allowCancelation\":{\"type\":\"boolean\",\"description\":\"Indicates whether cancelation is allowed.\"},\"allowChangeSeller\":{\"type\":\"boolean\",\"description\":\"Indicates whether seller changing is allowed.\"},\"isUserDataVisible\":{\"type\":\"boolean\",\"description\":\"Indicates whether user data is visible.\"},\"orderFormCreationDate\":{\"type\":\"string\",\"description\":\"`orderForm` creation date.\"},\"salesAssociateId\":{\"type\":\"string\",\"description\":\"Sales Associate (Seller) identification code.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/checkout/pub/orders - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -7272,7 +7272,7 @@ } }, { - "id": "e78407bb-f108-4481-8c9f-083d90675e36", + "id": "44956365-e776-4acf-8349-258a076ca148", "name": "Process order", "request": { "name": "Process order", @@ -7356,7 +7356,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "e1f4ad26-28a5-4e74-9f6e-4968e481686b", + "id": "181caa1f-dd85-489e-813e-65e3ac38b307", "name": "OK", "originalRequest": { "url": { @@ -7432,7 +7432,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2ab6f7bd-d489-41a0-8bbb-c4bacc149277", + "id": "f28ebd0f-172c-46e0-8d41-f91a66e0c1e4", "name": "Precondition Required\r\n\r\nUsed to indicate that a payment redirection flow is required to complete the order.", "originalRequest": { "url": { @@ -7518,7 +7518,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7691a501-f219-41d9-ad75-72b8c3eb2acb", + "id": "38ebc320-741a-4f95-922f-bcd389f2e3f0", "name": "Internal Server Error", "originalRequest": { "url": { @@ -7605,7 +7605,7 @@ { "listen": "test", "script": { - "id": "0d770f06-20b0-492d-9e98-1a818280ff63", + "id": "72475040-029a-4e93-a2f8-352513beaa9d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pub/gatewayCallback/:orderGroup - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -7621,7 +7621,7 @@ "event": [] }, { - "id": "93747aff-23e9-4529-a1f3-4217a16d4625", + "id": "679d462d-4361-42a2-81f4-3602e1b0b1a2", "name": "Region", "description": { "content": "", @@ -7629,7 +7629,7 @@ }, "item": [ { - "id": "501d9624-b14f-4429-955c-6f350a564f0a", + "id": "2efe6985-2251-4233-a67e-99945b518d2e", "name": "Get sellers by region or address", "request": { "name": "Get sellers by region or address", @@ -7740,7 +7740,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "37276d84-9482-49d4-a1db-fca1e5fdddda", + "id": "97540d38-c92c-4a12-b5f1-894638f540f2", "name": "OK", "originalRequest": { "url": { @@ -7845,7 +7845,7 @@ { "listen": "test", "script": { - "id": "c75dbdad-b4e4-48fd-9ec1-011375d76f5c", + "id": "13749a5a-54e3-45b7-a06f-2b0bb5fa77ae", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pub/regions/:regionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7903,7 +7903,7 @@ } ], "info": { - "_postman_id": "1524f754-3c08-4f2c-94c9-444787f01a51", + "_postman_id": "2faa7998-9687-4ae0-8fb6-f7a882af654f", "name": "Checkout API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 3fca82be998bc875e6078e2b9bb559b919c66f95 Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Fri, 29 May 2026 12:35:48 -0300 Subject: [PATCH 5/7] fix(description): edit isDisposable description --- VTEX - Checkout API.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index c99b98538..5a121eef8 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -38754,7 +38754,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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` are saved.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", From 8ff151d5819b1424a528c295acfe4d4cd4e4bbaf Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Wed, 3 Jun 2026 11:35:30 -0300 Subject: [PATCH 6/7] fix(checkout api): add reviewer suggestions --- VTEX - Checkout API.json | 74 ++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index 5a121eef8..aa86b3856 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -653,7 +653,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`. If the store uses the [Delivery Option](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`.", + "description": "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, as the example `1223d5b4-52a4-442f-ab23-01345b60be48`.", "nullable": true }, "selectedDeliveryChannel": { @@ -682,7 +682,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -690,7 +690,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -944,7 +944,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -952,7 +952,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -4839,7 +4839,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -5273,7 +5273,7 @@ "post": { "tags": ["Cart attachments"], "summary": "Add shipping address and select delivery option", - "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r>ℹ️ This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request.\r\n\r\nIf no `selectedSla` is sent in the request body, the API will automatically select the best delivery option among the ones available in the `slas` array, excluding pickup options and scheduled delivery options. If no such option is available, none will be selected.\r\n\r\nThe best delivery option selected is the one that can fulfill the biggest item quantity for the lowest price. This selection does not consider delivery time.\r\n\r\nThis process happens after the White Label Sellers selection in the Checkout pipeline. White label sellers selection is a separate process and is the responsibility of the Order Allocation module. For more information, see the [White label sellers selection](https://help.vtex.com/en/docs/tutorials/white-label-sellers-selection) article.\r\n\r\nFor a pickup option or a scheduled delivery option to be selected, it must be explicitly sent in the request body in the `selectedSla` field.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 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.", + "description": "Use this request to include shipping information and\/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses, send the `selectedAddresses` array. To select a delivery option, use the `logisticsInfo` array.\r\n\r\nThe `orderFormId` identifies the shopping cart. For more information, see [orderForm](https:\/\/developers.vtex.com\/docs\/guides\/orderform-fields).\r\n\r\n>\u2139\uFE0F This request has a time out of 12 seconds.\r\n\r\n>\u26A0\uFE0F If the request modifies a customer with a complete profile, the response will return masked data. To access unmasked data, use an authenticated request.\r\n\r\n## Delivery option selection\r\n\r\nIf no `selectedSla` is sent in the request body, the API will automatically select the best delivery option among the ones available in the `slas` array, excluding pickup options and scheduled delivery options. If no such option is available, none will be selected.\r\n\r\nThe best delivery option selected is the one that can fulfill the biggest item quantity for the lowest price. This selection does not consider delivery time.\r\n\r\nThis process happens after the White Label Sellers selection in the Checkout pipeline. White label sellers selection is a separate process and is the responsibility of the Order Allocation module. For more information, see the [White label sellers selection](https:\/\/help.vtex.com\/en\/docs\/tutorials\/white-label-sellers-selection) article.\r\n\r\nFor a pickup option or a scheduled delivery option to be selected, it must be explicitly sent in the request body in the `selectedSla` field.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https:\/\/developers.vtex.com\/docs\/guides\/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "AddShippingAddress", "security": [], "parameters": [ @@ -5414,7 +5414,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", + "description": "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.", "example": "normal", "nullable": true } @@ -30544,7 +30544,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -30940,7 +30940,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -31003,7 +31003,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", + "description": "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.", "nullable": true }, "selectedDeliveryChannel": { @@ -31025,7 +31025,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -31033,7 +31033,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -31280,7 +31280,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -31353,7 +31353,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -32499,7 +32499,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -32894,7 +32894,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -32957,7 +32957,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", + "description": "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.", "nullable": true }, "selectedDeliveryChannel": { @@ -32979,7 +32979,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -32987,7 +32987,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -33203,7 +33203,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -33276,7 +33276,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -34340,7 +34340,7 @@ "nullable": true }, "isDisposable": { - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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.", + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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.", "type": "boolean" }, "postalCode": { @@ -35446,7 +35446,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", + "description": "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.", "example": "Express", "nullable": true }, @@ -36493,7 +36493,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -36556,7 +36556,7 @@ }, "selectedSla": { "type": "string", - "description": "Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Option](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.", + "description": "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.", "nullable": true }, "selectedDeliveryChannel": { @@ -36578,7 +36578,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -36586,7 +36586,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -36802,7 +36802,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -36875,7 +36875,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -37941,7 +37941,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." }, "city": { "type": "string", @@ -38341,7 +38341,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -38404,7 +38404,7 @@ }, "selectedSla": { "type": "string", - "description": "SLA selected by the customer. If the store uses the [Delivery Option](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`.", + "description": "SLA selected by the customer. 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`.", "nullable": true }, "selectedDeliveryChannel": { @@ -38426,7 +38426,7 @@ "properties": { "id": { "type": "string", - "description": "SLA ID. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "string", @@ -38434,7 +38434,7 @@ }, "name": { "type": "string", - "description": "SLA name. If the store uses the [Delivery Option](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`." + "description": "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": { "type": "array", @@ -38681,7 +38681,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", @@ -38754,7 +38754,7 @@ }, "isDisposable": { "type": "boolean", - "description": "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` are saved.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `residential`: may be disposable. Residential addresses loaded from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. Residential addresses entered by an unauthenticated shopper or by a shopper with an incomplete profile are disposable. The only exception is a first-time purchase, in which case all addresses are disposable since no complete profile exists yet.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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." + "description": "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` are saved.\r\n\r\nBehavior by address type:\r\n- `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart.\r\n- `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.\r\n- `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.\r\n- `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses.\r\n\r\nWhen 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": { "type": "string", From 0198918cbddc4d627e3bf1657191ca3fbd1cb350 Mon Sep 17 00:00:00 2001 From: Karen Krieger Date: Wed, 3 Jun 2026 11:45:25 -0300 Subject: [PATCH 7/7] fix(checkout api): fix spectral errors --- VTEX - Checkout API.json | 50 +++++++++------------------------------- 1 file changed, 11 insertions(+), 39 deletions(-) diff --git a/VTEX - Checkout API.json b/VTEX - Checkout API.json index aa86b3856..f3c3282c0 100644 --- a/VTEX - Checkout API.json +++ b/VTEX - Checkout API.json @@ -30277,8 +30277,7 @@ }, "recaptchaValidation": { "type": "string", - "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.", - "example": "vtexCriteria" + "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option." } } }, @@ -31595,40 +31594,33 @@ "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" + "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." }, "utmSource": { "type": "string", - "description": "UTM source.", - "example": "Facebook" + "description": "UTM source." }, "utmMedium": { "type": "string", - "description": "UTM medium.", - "example": "CPC" + "description": "UTM medium." }, "utmCampaign": { "type": "string", - "description": "UTM campaign.", - "example": "Black friday" + "description": "UTM campaign." }, "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 } } @@ -31672,7 +31664,6 @@ "optinNewsLetter": { "type": "boolean", "description": "`true` if the client opted to receive newsletter from the store.", - "example": false, "nullable": true } } @@ -31694,7 +31685,6 @@ "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": { @@ -33519,43 +33509,36 @@ "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" + "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." }, "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 } } @@ -33616,7 +33599,6 @@ "openTextField": { "type": "string", "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).", - "example": "open-text-example", "nullable": true }, "invoiceData": { @@ -36012,8 +35994,7 @@ }, "isCheckedIn": { "type": "boolean", - "description": "Indicates whether order is checked in.", - "example": false + "description": "Indicates whether order is checked in." }, "sellerOrderId": { "type": "string", @@ -38996,40 +38977,33 @@ "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" + "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." }, "utmSource": { "type": "string", - "description": "UTM source.", - "example": "Facebook" + "description": "UTM source." }, "utmMedium": { "type": "string", - "description": "UTM medium.", - "example": "CPC" + "description": "UTM medium." }, "utmCampaign": { "type": "string", - "description": "UTM campaign.", - "example": "Black friday" + "description": "UTM campaign." }, "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 } } @@ -39073,7 +39047,6 @@ "optinNewsLetter": { "type": "boolean", "description": "`true` if the client opted to receive newsletter from the store.", - "example": false, "nullable": true } } @@ -39095,7 +39068,6 @@ "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": {