openapi: 3.0.0 info: title: VTex Orders API description: "Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n### Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https://developers.vtex.com/docs/guides/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-)\r\n- `GET` [List orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel)\r\n- `POST` [Register change on order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/changes)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/payment-transaction)\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/feed/orders/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed/config)\r\n- `POST` [Create or update feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed/config)\r\n- `DELETE` [Delete feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/feed/config)\r\n- `GET` [Retrieve feed items](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed)\r\n- `POST` [Commit feed items](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed)\r\n- `POST` [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/hook/config)\r\n- `POST` [Create or update hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config)\r\n- `DELETE` [Delete hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/hook/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders)\r\ \n- `GET` [Retrieve user order details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/checkout/pvt/configuration/window-to-change-seller)\r\n- `POST` [Update window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/checkout/pvt/configuration/window-to-change-seller)" contact: {} version: '1.0' servers: - url: https://{accountName}.{environment}.com.br description: VTEX server URL. variables: accountName: description: Name of the VTEX account. Used as part of the URL. default: apiexamples environment: description: Environment to use. Used as part of the URL. enum: - vtexcommercestable default: vtexcommercestable paths: /api/oms/pvt/orders/{orderId}: get: tags: - Orders summary: VTex Get order description: "This endpoint retrieves order details by searching a specific order ID or sequence number. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> **Onboarding guide** \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **List Orders** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | List Orders |\r\n| Checkout Admin | List Orders |\r\n| IntegrationProfile - Fulfillment Oms | List Orders |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: GetOrder parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: 'Order ID is a unique code that identifies an order. Instead of using `orderId`, you can also make the request using the sequence, a six-digit string that follows the order ID. For example, in order 1268540501456-01 (501456), the sequence is 501456. To use this parameter, replace the value between `{ }` keys in `seq{sequence-number}` with the sequence. For example: `seq501456`.' example: 1172452900788-01 or seq501456 required: true style: simple schema: type: string example: 1172452900788-01 or seq501456 responses: '200': description: OK content: application/json: schema: type: object properties: orderId: type: string description: Unique code that identifies an order. sequence: type: string description: Six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. marketplaceOrderId: type: string description: Marketplace order ID. marketplaceServicesEndpoint: type: string description: Endpoint provided by the marketplace for post purchase communication. sellerOrderId: type: string description: ID of the seller related to the order. It can be a VTEX seller or an external seller. origin: type: string description: Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. affiliateId: type: string description: Three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) code that identifies the marketplace where the order originates. This ID is configured in the seller's VTEX account. salesChannel: type: string description: Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. merchantName: type: string description: For a VTEX store, the merchant's name will be the same as the account name. An external seller can have a `merchantName`, and in this case the field will not correspond to an account name. status: type: string description: Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). workflowIsInError: type: boolean description: Indicates if the order workflow presents an error that cannot be solved by automatic retry (`true`), or if there are no processing errors (`false`). statusDescription: type: string description: '`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.' deprecated: true value: type: integer description: Order's total value in cents. creationDate: type: string description: Order's creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. lastChange: type: string description: Order's last change date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. orderGroup: type: string description: Order's group ID. followUpEmail: type: string description: Email of the store's employee responsible for managing the order. lastMessage: type: string nullable: true description: Transactional message sent most recently. hostname: type: string description: Account host name, which is the [domain](https://help.vtex.com/en/tutorial/configuring-the-store-domain--tutorials_2450#store-address-structure) registered in **Account Settings**. isCompleted: type: boolean description: When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet. roundingError: type: integer description: Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field. orderFormId: type: string description: Unique identifier of the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields). allowCancellation: type: boolean description: When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order. allowEdition: type: boolean description: When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order. isCheckedIn: type: boolean description: This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not. authorizedDate: type: string description: Authorized order date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. invoicedDate: type: string nullable: true description: Order's invoice date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. cancelReason: type: string description: Reason for order cancellation. nullable: true checkedInPickupPointId: type: string description: If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made. totals: type: array description: List with details about orders' totals. items: type: object description: Information about orders' totals. properties: id: type: string description: Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. name: type: string description: Name of the total count. value: type: integer description: Total value in cents of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. sellers: type: array description: List of all the sellers associated with the order. items: type: object description: Information about the seller associated with the order. properties: id: type: string description: Unique identifier of the seller. name: type: string description: Seller's name. logo: type: string description: URL of the seller's logo. fulfillmentEndpoint: type: string description: URL of the endpoint for fulfillment of seller's orders. clientPreferencesData: type: object description: Information about customer's preferences. properties: locale: type: string description: Language code of the customer's preferred language while accessing the store. optinNewsLetter: type: boolean description: When set as `true`, this field indicates that the customer opted to receive the newsletter, and when set as `false`, it means they did not. cancellationData: type: object description: Information about order cancellation, when applicable. properties: RequestedByUser: type: boolean description: Indicates if the order cancellation was requested by the customer (`true`) or not (`false`). nullable: true RequestedBySystem: type: boolean description: Indicates if the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example. nullable: true RequestedBySellerNotification: type: boolean description: Indicates if the order cancellation was requested by the seller (`true`) or not (`false`). nullable: true RequestedByPaymentNotification: type: boolean description: Indicates if the order cancellation was requested by the payment gateway (`true`) or not (`false`). nullable: true Reason: type: string description: Reason why the order was cancelled. nullable: true CancellationDate: type: string description: Order cancellation date in [UTC time format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`. nullable: true nullable: true taxData: type: object description: Order's tax information. properties: areTaxesDesignatedByMarketplace: type: boolean description: Indicates if the taxes were designated by the marketplace (`true`) or not (`false`). taxInfoCollection: type: array description: Array with taxes' details. items: type: object description: Taxes' details. properties: itemIndex: type: integer description: Item's index number. sku: type: string description: Alphanumeric sequence that identifies an SKU. priceTags: type: array description: Items' price tag information with original taxes calculated at order placement. items: type: object description: Price tag information. properties: identifier: type: string description: Price tag identifier code. isPercentual: type: boolean description: Defines if the price tag is a percentage (`true`) or not (`false`). name: type: string description: Price tag name. value: type: number description: Price tag value in cents. rawValue: type: number description: Price tag raw value that can contain up to five decimals, separated by a period. nullable: true subscriptionData: type: object description: Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable. nullable: true properties: SubscriptionGroupId: type: string description: ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions. nullable: true Subscriptions: type: array description: List with subscriptions details. nullable: true items: type: object description: Subscription details. properties: ExecutionCount: type: integer description: Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on. PriceAtSubscriptionDate: type: number description: Value of the order when the customer signed up for subscriptions. Subscriptions created via Admin or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3. deprecated: true ItemIndex: type: integer description: Each item in the subscription order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on. Plan: type: object description: Information about the subscription's validility and frequency. properties: type: type: string description: Type of plan. frequency: type: object description: Information about subscriptions' recurrence. properties: periodicity: type: string description: Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`. interval: type: integer description: Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on. validity: type: object description: Information about the period during which the subscription will be valid. properties: begin: type: string description: Subscriptions' beginning date in [UTC time format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`. end: type: string description: Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`. nullable: true itemMetadata: type: object description: Metadata information about the order's items. properties: Items: type: array description: List of order items' metadata. items: type: object description: Order item metadata. properties: Id: type: string description: Unique numerical identifier of the SKU. Seller: type: string description: Unique identifier of the SKU seller. Name: type: string description: Name of the item as displayed to customers in the storefront. SkuName: type: string description: Name of the SKU corresponding to the item. ProductId: type: string description: ID of the product associated with the item. RefId: type: string description: SKU reference ID. Ean: type: string description: SKU EAN. ImageUrl: type: string description: SKU image URL. DetailUrl: type: string description: SKU slug. AssemblyOptions: type: array description: '[Assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) information related to the item, if there are any.' nullable: true items: type: object description: '[Assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) details.' properties: Id: type: string description: Assembly option ID. Name: type: string description: Assembly option name. Required: type: boolean description: If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional. InputValues: type: object description: Assembly option content. additionalProperties: true nullable: true Composition: type: object description: Assembly option composition. additionalProperties: true nullable: true marketplace: type: object description: Details about the marketplace related to the order. properties: baseURL: type: string description: Marketplace base URL. isCertified: type: boolean nullable: true description: Defines if it is a [VTEX certified marketplace](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-a-certified-marketplace) (`true`) or not (`false`). name: type: string description: Marketplace name. storePreferencesData: type: object description: Store's configuration data, stored in [Account settings](https://help.vtex.com/en/tutorial/account-details-page--2vhUVOKfCaswqLguT2F9xq). properties: countryCode: type: string description: Three-digit country code, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. currencyCode: type: string description: Currency code in [ISO 4217](https://www.iban.com/currency-codes) format. currencyFormatInfo: type: object description: Object with currency format details. properties: CurrencyDecimalDigits: type: integer description: Quantity of currency decimal digits. CurrencyDecimalSeparator: type: string description: Defines what currency decimal separator will be applied. CurrencyGroupSeparator: type: string description: Defines what currency group separator will be applied. CurrencyGroupSize: type: integer description: Defines how many characters will be grouped. StartsWithCurrencySymbol: type: boolean description: Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`). currencyLocale: type: integer description: Currency Locale Code in [LCID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) format. currencySymbol: type: string description: Currency symbol. timeZone: type: string description: Time zone from where the order was made. customData: type: string nullable: true description: Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt. commercialConditionData: type: string nullable: true description: Information about commercial conditions. openTextField: type: string description: "Optional field with additional information about the order. This field must be filled in using the following format: \n\r```\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r```\n\r." nullable: true invoiceData: type: object description: Order's invoice information. nullable: true properties: address: type: object description: Invoice information. properties: postalCode: type: string description: Postal code of the order's invoice address. city: type: string description: City of the order's invoice address. state: type: string description: State of the order's invoice address. country: type: string description: Three-digit country code of the order's invoice address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. street: type: string description: Street of the order's invoice address. number: type: string description: Number of the building of the order's invoice address. neighborhood: type: string description: Neighborhood of the order's invoice address. complement: type: string description: Complement to the order's invoice address, such as apartment number. nullable: true reference: type: string description: Additional information to help locate the order's invoice address. nullable: true settleInvoices: type: array description: Number of settled invoice. items: type: string description: Settled invoices numeric identifiers. changesAttachment: type: object description: Information about changes in the order. properties: id: type: string description: Object ID, the expected value is `changeAttachment`. changesData: type: array description: Order change information. nullable: true items: type: object description: Order change details. properties: reason: type: string description: Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails. discountValue: type: integer description: Order change discount value. incrementValue: type: integer description: Order change increment value. itemsAdded: type: array description: Information about items added to the order. nullable: true items: type: object description: Added item information. properties: id: type: string description: SKU ID of the item added. name: type: string description: Name of the item added. quantity: type: integer description: Number of units added. price: type: integer description: Total value increased to the order. unitMultiplier: type: string nullable: true description: Unit multiplier of the item added. itemsRemoved: type: array description: Information about items removed from the order. nullable: true items: type: object description: Removed item information. properties: id: type: string description: SKU ID of the item removed. name: type: string description: Name of the item removed. quantity: type: integer description: Number of units removed. price: type: integer description: Total value decreased from the order. unitMultiplier: type: string nullable: true description: Unit multiplier of the item removed from the order. receipt: type: object description: Information about the receipt for changed orders. properties: date: type: string description: Date when the receipt was created. orderId: type: string description: Order ID. receipt: type: string description: Receipt's unique identifier code. callCenterOperatorData: type: object nullable: true description: Information about the call center operator responsible for the order. properties: id: type: string description: Call center operator identification code. email: type: string description: Call center operator email. userName: type: string description: Call center operator user name. packageAttachment: type: object description: Information about shipping packages, created after order invoicing. nullable: true properties: packages: type: array description: List with packages' information. items: type: object description: Package details. properties: items: type: array description: Information about package items. items: type: object description: Package item details. properties: itemIndex: type: integer description: Package item index nunmber. quantity: type: integer description: Package item quantity. price: type: integer description: Package item price in cents. description: type: string description: Package item description. nullable: true unitMultiplier: type: number description: Package item unit multiplier. nullable: true courier: type: string description: Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping. nullable: true invoiceNumber: type: string description: Unique identification code of the package invoice. invoiceValue: type: integer description: Package invoice value in cents. invoiceUrl: type: string description: Package invoice URL. nullable: true issuanceDate: type: string description: Package invoice issuance date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. trackingNumber: type: string description: Package [tracking number](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). nullable: true invoiceKey: type: string description: Package invoice key. nullable: true trackingUrl: type: string description: Package tracking URL. nullable: true embeddedInvoice: type: string description: Package invoice text in [xml format](https://help.vtex.com/en/tutorial/configuring-xml--tutorials_242). This field is important for stores integrated with [external marketplaces](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide). type: type: string description: "Package invoice type, which can be:\r\n- `Output`: selling order invoice.\r\n- `Input`: returning items invoice." courierStatus: type: object description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) package shipping information.' nullable: true properties: status: type: string description: Defines if a carrier was assigned for order shipping (`ok`) or not (`null`). nullable: true finished: type: boolean description: Defines if the carrier has already delivered the package (`true`) or not (`false`). deliveredDate: type: string description: Package delivery date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. data: type: array description: Package tracking information. items: type: object description: Package tracking details. properties: lastChange: type: string description: Package tracking date since last update in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. city: type: string description: Package current tracking city. state: type: string description: Package current tracking state in two-digit code format. description: type: string description: Package tracking description. createDate: type: string description: Package tracking creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. cfop: type: string description: '[CFOP](https://www.gov.br/receitafederal/pt-br/acesso-a-informacao/acoes-e-programas/facilitacao/anexo-ecf-cfop) (_Código Fiscal de Operação e Prestação_) is a Brazilian fiscal code of operations and services that classifies business transactions types.' nullable: true restitutions: type: object description: Information about a value being returned to the customer. This field applies only to invoices with the `Input` type because it relates to returning items. properties: Refund: type: object description: Customer refund details. properties: value: type: integer description: Refund value in cents. giftCardData: type: string description: Refund involving [Gift Card](https://developers.vtex.com/docs/guides/gift-card-integration-guide). nullable: true items: type: array description: Information about the items being returned. nullable: true items: type: object description: Returned item details. properties: useFreight: type: boolean description: Defines if the refund includes freight values (`true`) or not (`false`). nullable: true isCompensation: type: boolean description: Defines if there are compensated unit tags in the package (`true`) or not (`false`). compensationValue: type: integer description: Compensational refund value in cents. id: type: string description: SKU unique identification code of the returned item. quantity: type: integer description: Number of items being returned. price: type: integer description: Returned item price in cents. description: type: string description: Customer reason for returning the item. volumes: type: integer description: Indicates the number of boxes (volumes) needed to contain the package items. For example, two refrigerators do not fit in a single volume, so this field would have value `2`. EnableInferItems: type: boolean description: Defines if the package items' value should be inferred by the invoice value (`true`) or not (`false`). nullable: true paymentData: type: object description: Detailed information about payments. properties: transactions: type: array description: Transactions details. items: type: object description: Financial transactions. properties: isActive: type: boolean description: When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive. transactionId: type: string description: ID of the transaction. merchantName: type: string description: Account name of the merchant that will receive the payment. payments: type: array description: Detailed information about payments. items: type: object description: Payment details. properties: id: type: string description: VTEX payment unique identifier. paymentSystem: type: string description: Payment system ID. paymentSystemName: type: string description: Payment system name. value: type: integer description: Payment value in cents. installments: type: integer description: Number of payment installments. referenceValue: type: integer description: Payment reference value in cents. cardHolder: type: string nullable: true description: Name of the card owner. cardNumber: type: string nullable: true description: Card number. firstDigits: type: string nullable: true description: Card first digits. lastDigits: type: string nullable: true description: Card last digits. cvv2: type: string nullable: true description: Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions. expireMonth: type: string nullable: true description: Card expiration month, in 2-digit format. expireYear: type: string nullable: true description: Card expiration year, in 4-digit format. url: type: string description: Payment URL. nullable: true giftCardId: type: string nullable: true description: Gift Card ID. giftCardName: type: string nullable: true description: Gift Card name. giftCardCaption: type: string nullable: true description: Gift Card caption. redemptionCode: type: string nullable: true description: Code for the customer to use the Gift Card. group: type: string description: "Transaction payment method, which can have one of the following values: \n\r\n- **Credit card:** `creditCard` \r\n\r\n- **Debid card:** `debitCard`\r\n\r\n- **Bank invoice:** `bankInvoice`\r\n\r\n- **Promissory:** `promissory` \r\n\r\n- **Gift card:** `giftCard` \n\r\n- **Pix:** `instantPayment`." tid: type: string nullable: true description: Provider's unique identifier for the transaction. dueDate: type: string description: Payment due date, in `MM/YY` format. nullable: true connectorResponses: type: object description: Information about the connector responses. properties: authId: type: string description: Connector's authorization ID. Tid: type: string description: Provider's unique identifier for the transaction. ReturnCode: type: string description: Provider's operation/error code to be logged. nullable: true Message: type: string description: Provider's operation/error message to be logged. nullable: true giftCardProvider: type: string description: Gift Card provider ID. giftCardAsDiscount: type: boolean description: Defines if the Gift Card is a discount over the price (`true`) or not (`false`). koinUrl: type: string description: Koin connector URL. nullable: true accountId: type: string description: Payment account ID. parentAccountId: type: string description: Retrieves the main account ID if the payment was made in a subaccount. nullable: true bankIssuedInvoiceIdentificationNumber: type: string description: Bank issued invoice numeric sequence. nullable: true bankIssuedInvoiceIdentificationNumberFormatted: type: string description: Bank issued invoice numeric sequence formatted as customers see. nullable: true bankIssuedInvoiceBarCodeNumber: type: string description: Bank issued invoice bar code number. nullable: true bankIssuedInvoiceBarCodeType: type: string description: Bank issued invoice bar code type. nullable: true billingAddress: type: object description: Billing address information. nullable: true properties: country: type: string description: Billing address three-digit country code, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. street: type: string description: Billing address street. number: type: string description: Billing address number. complement: type: string description: Billing address complement. neighborhood: type: string description: Billing address neighborhood. postalCode: type: string description: Billing address postal code. city: type: string description: Billing address city. state: type: string description: Billing address state/province. giftCards: type: array description: Array with information about Gift Cards. items: type: string description: Gift Cards information. shippingData: type: object description: Shipping information. properties: id: type: string description: Object ID, the expected value is `shippingData`. address: type: object description: Shipping address details. properties: addressType: type: string description: Type of address. For example, `residential` or `pickup`. receiverName: type: string description: Full name of the order receiver. addressId: type: string description: Shipping address ID. versionId: type: string description: Shipping address version ID. nullable: true entityId: type: string description: Shipping address entity ID. nullable: true postalCode: type: string description: Shipping address postal code. city: type: string description: Shipping address city. state: type: string description: Shipping address state/province. country: type: string description: Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. street: type: string description: Shipping address street. number: type: string description: Shipping address number. neighborhood: type: string description: Shipping address neighborhood. complement: type: string description: Shipping address complement. reference: type: string nullable: true description: Shipping address additional information. geoCoordinates: type: array description: Pair of geocoordinates, first longitude then latitude. items: type: number description: Longitude and latitude. logisticsInfo: type: array description: Array of objects containing item's logistics information. items: type: object description: Logistics information. properties: itemIndex: type: integer description: Index of the item starting from 0. selectedSla: type: string description: Selected shipping option. lockTTL: type: string description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time. price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. listPrice: type: integer description: SKU [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price). sellingPrice: type: integer description: Item's selling price. deliveryWindow: type: string nullable: true description: '[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item.' deliveryCompany: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.' shippingEstimate: type: string description: Total shipping estimate time in days. For instance, three business days is represented `3bd`. shippingEstimateDate: type: string description: Shipping estimate date, defined after the confirmation of the order. slas: type: array description: Service Level Agreement (SLA) corresponding to [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). items: type: object description: Order shipping SLA details. properties: id: type: string description: ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). name: type: string description: Name of the shipping policy. shippingEstimate: type: string description: Total shipping estimate time in days. For instance, three business days is represented `3bd`. deliveryWindow: type: string nullable: true description: '[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.' price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. deliveryChannel: type: string description: Defines if the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: type: object description: Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). properties: additionalInfo: type: string nullable: true description: Additional information about the pickup point. address: type: object nullable: true description: Pickup point address details. properties: addressType: type: string description: Type of address. For example, `residential` or `pickup`. nullable: true receiverName: type: string description: Full name of the order receiver. nullable: true addressId: type: string description: Pickup point address ID. nullable: true versionId: type: string description: Pickup point address version ID. nullable: true entityId: type: string description: Pickup point address entity ID. nullable: true postalCode: type: string description: ' Pickup point postal code.' nullable: true city: type: string description: Pickup point address city. nullable: true state: type: string description: Pickup point address state/province. nullable: true country: type: string description: Pickup point address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. nullable: true street: type: string description: Pickup point address street. nullable: true number: type: string description: Pickup point address number. nullable: true neighborhood: type: string description: Pickup point address neighborhood. nullable: true complement: type: string description: Pickup point address complement. nullable: true reference: type: string description: Pickup point address additional information. nullable: true geoCoordinates: type: array description: Pair of geocoordinates, first longitude then latitude. nullable: true items: type: number description: Longitude and latitude. nullable: true dockId: type: string nullable: true description: '[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID related to the delivery or the pickup point.' friendlyName: type: string nullable: true description: Name of the pickup point displayed at checkout. isPickupStore: type: boolean description: Defines if the type of shipping is pickup (`true`) or not (`false`). polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. lockTTL: type: string description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. pickupPointId: type: string description: '[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.' transitTime: type: string description: Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. pickupDistance: type: number description: Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. shipsTo: type: array items: type: string description: Three-digit country code of the shipping address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. description: List of countries of the shipping address. deliveryIds: type: array description: Information about delivery IDs. items: type: object description: Delivery IDs. properties: courierId: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE)''s ID.' courierName: type: string description: Carrier's name. dockId: type: string description: ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj). quantity: type: integer description: Quantity of items. warehouseId: type: string description: ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). accountCarrierName: type: string description: Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE). kitItemDetails: type: array description: Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any. nullable: true items: type: string description: Kits information. deliveryChannels: type: array description: List of delivery channels associated with the trade policy. items: type: object properties: id: type: string description: Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`. stockBalance: type: integer description: Stock check for an SKU availability. description: Delivery channels information. deliveryChannel: type: string description: Defines if the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: type: object description: Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). properties: additionalInfo: type: string nullable: true description: Additional information about the pickup point. address: type: string nullable: true description: Pickup point's address. dockId: type: string nullable: true description: ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point. friendlyName: type: string nullable: true description: Name of the pickup point displayed at checkout. isPickupStore: type: boolean description: Defines if the type of shipping is pickup (`true`) or not (`false`). nullable: true addressId: type: string description: Address ID. nullable: true versionId: type: string description: Shipping address version ID. nullable: true entityId: type: string description: Shipping address entity ID. nullable: true polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. pickupPointId: type: string description: '[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)''s ID.' nullable: true transitTime: type: string description: Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. nullable: true trackingHints: type: array description: List containing order shipping label information. items: type: object description: Shipping label information. properties: trackingId: type: string description: Tracking ID. courierName: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) name.' trackingUrl: type: string description: Tracking URL. trackingLabel: type: string description: Tracking label. nullable: true selectedAddresses: type: array description: Information about selected adresses. items: type: object description: Selected adresses. properties: addressId: type: string description: Selected address ID. versionId: type: string description: Shipping address version ID of the selected address. nullable: true entityId: type: string description: Shipping address entity ID of the selected address. nullable: true addressType: type: string description: Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`. receiverName: type: string description: Full name of the person who is going to receive the order in the selected address. street: type: string description: Street of the selected address. number: type: string description: Number of the building, house or apartment of the selected address. complement: type: string description: Complement to the selected address if it applies. neighborhood: type: string description: Neighborhood of the selected address. postalCode: type: string description: Postal code of the selected address. city: type: string description: City of the selected address. state: type: string description: State of the selected address. country: type: string description: Three-digit country code of the selected address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. reference: type: string nullable: true description: Complement to help locate the selected address. geoCoordinates: type: array items: type: number description: Longitude and latitude geocoordinates. description: List with the selected address's geocoordinates, first longitude then latitude. contactInformation: type: array description: Array with customer contact information. items: type: object description: Contact information. properties: id: type: string description: Customer contact ID. email: type: string description: Customer contact email. firstName: type: string description: Customer contact first name. lastName: type: string description: Customer contact last name. phone: type: string description: Customer contact phone number. document: type: string description: Customer contact document ID. documentType: type: string description: Customer contact document type. entityId: type: string description: Entity identification code. versionId: type: string description: Version identification code. ratesAndBenefitsData: type: object description: Information on promotions and taxes that apply to the order. properties: id: type: string description: ID of the rate or benefit. rateAndBenefitsIdentifiers: type: array description: Information about order's promotions and taxes identifiers. items: type: object description: Promotions or tax information. properties: description: type: string description: Promotion or tax description. nullable: true featured: type: boolean description: Defines if the promotion or tax is cumulative (`true`) or not (`false`). id: type: string description: Promotion or tax ID. name: type: string description: Promotion or tax name. matchedParameters: type: object description: Informs the criteria and conditions fulfilled so the promotion became valid. additionalProperties: true additionalInfo: type: object description: 'Object containing promotion or tax additional information. For example { Free shipping: 100,00 }.' nullable: true marketingData: type: object description: Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs. properties: id: type: string description: Object ID. The expected value is `marketingData`. utmSource: type: string description: Value of the `utm_source` parameter of the URL that led to the request. utmPartner: type: string description: UTM Source Parameters. utmMedium: type: string description: Value of the `utm_medium` parameter of the URL that led to the request. utmCampaign: type: string description: Value of the `utm_campaign` parameter of the URL that led to the request. coupon: type: string description: Coupon code. utmiCampaign: type: string description: Internal UTM value `utmi_cp`. utmipage: type: string description: Internal UTM value `utmi_p`. utmiPart: type: string description: Internal UTM value `utmi_pc`. marketingTags: type: array description: Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions. items: type: string description: Marketing tag. nullable: true giftRegistryData: type: object description: Information about [gift list](https://developers.vtex.com/docs/guides/creating-gift-lists). nullable: true properties: giftRegistryId: type: string description: Gift list ID. giftRegistryType: type: string description: '[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list).' giftRegistryTypeName: type: string description: Gift list type name. addressId: type: string description: Gift list shipping address ID. description: type: string description: Gift list description. clientProfileData: type: object description: Object with information on the client's profile. properties: id: type: string description: Object ID, the expected value is `clientProfileData`. email: type: string description: Customer email. firstName: type: string description: Customer first name. lastName: type: string description: Customer last name. documentType: type: string description: Type of the document informed by the customer. document: type: string description: Document identification code informed by the customer. phone: type: string description: Customer phone number. corporateName: type: string nullable: true description: If the customer is a legal entity, this field includes the corporate name. tradeName: type: string nullable: true description: If the customer is a legal entity, this field includes the trade name. corporateDocument: type: string nullable: true description: If the customer is a legal entity, this field includes the corporate document. stateInscription: type: string nullable: true description: If the customer is a legal entity, this field includes the state inscription. corporatePhone: type: string nullable: true description: If the customer is a legal entity, this field includes the company's phone number. isCorporate: type: boolean description: Defines if the customer is a legal entity (`true`) or not (`false`). userProfileId: type: string description: Customer user profile ID. userProfileVersion: type: string nullable: true description: Customer user profile version. customerClass: type: string nullable: true description: Customer class identification. customerCode: type: string nullable: true description: Customer code. items: type: array description: Information about order's items. items: type: object properties: uniqueId: type: string description: Alphanumeric sequence that identifies an SKU in a given order. id: type: string description: Unique SKU identifier. productId: type: string description: ID of the product associated with the item. ean: type: string nullable: true description: EAN of the SKU. lockId: type: string description: Reservation ID. itemAttachment: type: object description: Item attachment information. properties: content: type: object description: Item attachment custom field for content. name: type: string nullable: true description: Item attachment name. attachments: type: array items: type: string description: Attachments information. description: Array containing information on attachments. quantity: type: integer description: Quantity of items. seller: type: string description: Seller related to the order. name: type: string description: Item's name. refId: type: string description: Product referencial code associated with the item. price: type: integer description: Item's price. listPrice: type: integer description: Item's [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price). manualPrice: type: string nullable: true description: Item's [manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf). priceTags: type: array items: type: string description: Price modifiers. description: List of objects with item's price modifiers. imageUrl: type: string description: SKU image URL. detailUrl: type: string description: SKU slug. components: type: array items: type: string description: Components. description: Item's components. bundleItems: type: array items: type: object description: Item's offering details. properties: id: type: integer description: Offering ID. quantity: type: integer description: Offering quantity. description: This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering. params: type: array items: type: string description: Information about params. description: Array with information about params. offerings: type: array items: type: string description: Service name related to the item. description: Item's offerings, which are services related to the item. For example, guarantee or installation. attachmentOfferings: type: array description: Array containing attachments details. nullable: true items: type: object description: Attachment details. properties: name: type: string description: Name of the attachment. nullable: true required: type: boolean description: Defines if the attachment is required (`true`) or not (`false`). nullable: true schema: type: object description: Schema of the content declared in the field `attachmentOfferings`. nullable: true sellerSku: type: string description: SKU ID from the seller perspective. priceValidUntil: type: string nullable: true description: Date until when the price is going to be valid if there is a promotion. commission: type: integer description: Commission value registered for the seller. tax: type: integer description: Item's tax. preSaleDate: type: string nullable: true description: Item's pre sale date. additionalInfo: type: object description: Additional information about the item. properties: brandName: type: string description: Item's brand name. brandId: type: string description: Item's brand ID. categoriesIds: type: string description: Item's category ID. categories: type: array description: Items categories information. items: type: object description: Category information. properties: id: type: number description: Category ID. name: type: string description: Category name. productClusterId: type: string description: All product clusters related to the item. commercialConditionId: type: string description: Commercial conditions ID. dimension: type: object description: Item's dimensions. properties: cubicweight: type: number description: Item's cubic weight. height: type: integer description: Item's height. length: type: integer description: Item's length. weight: type: integer description: Item's weight. width: type: integer description: Item's width. offeringInfo: type: string nullable: true description: 'Information about services related to the item. For example: guarantee or installation.' offeringType: type: string nullable: true description: Offering type. offeringTypeId: type: string nullable: true description: Offering type ID. measurementUnit: type: string description: Item's measurement unit. unitMultiplier: type: integer description: Item's unit multiplier. sellingPrice: type: integer description: Item's selling price. isGift: type: boolean description: This field is `true` when the item is a gift in order context and `false` when it is not. shippingPrice: type: string nullable: true description: Item's shipping price. rewardValue: type: integer description: Item's reward value. freightCommission: type: integer description: Value of the freight commission. priceDefinitions: type: object description: Item's price information. properties: sellingPrices: type: array description: Details on item's selling price. items: type: object description: Selling price. properties: value: type: integer description: Total value of items in cents. quantity: type: integer description: Quantity of items. calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value of all item's units in cents. taxCode: type: string nullable: true description: Item's tax code. parentItemIndex: type: integer nullable: true description: Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options. parentAssemblyBinding: type: string nullable: true description: When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH). callCenterOperator: type: string description: Identification code of the call center operator responsible for the order. nullable: true serialNumbers: type: string description: This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control. deprecated: true nullable: true assemblies: type: array description: Information about items customization. nullable: true items: type: string description: Customization information. costPrice: type: integer description: Item's cost price. description: Items information. marketplaceItems: type: array description: Array with marketplace items information. items: type: string description: Marketplace items. example: orderId: 1172452900788-01 sequence: '502556' marketplaceOrderId: 1172452900788-01 marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v502556llux-01 origin: Marketplace affiliateId: GHB salesChannel: '1' merchantName: luxstore status: handling workflowIsInError: false statusDescription: Preparando Entrega value: 1160 creationDate: '2024-02-04T20:09:43.899958+00:00' lastChange: '2024-02-06T20:46:11.7010747+00:00' orderGroup: '1415461749731' followUpEmail: david@luxstore.com lastMessage: Your payment was approved hostname: luxstore isCompleted: true roundingError: 0 orderFormId: 33c887b2-bf49-4a18-8a0a-acc6b0d724bf allowCancellation: true allowEdition: false isCheckedIn: false authorizedDate: '2024-02-04T20:46:11.7010747+00:00' invoicedDate: '2024-02-09T10:17:40.5322681+00:00' cancelReason: Item size was too large. checkedInPickupPointId: storeNameExample_901 totals: - id: Items name: Total dos Itens value: 99 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 300 - id: Tax name: Total da Taxa value: 0 sellers: - id: '1' name: Lux Store logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName clientPreferencesData: locale: en-US optinNewsLetter: true cancellationData: RequestedByUser: true RequestedBySystem: false RequestedBySellerNotification: false RequestedByPaymentNotification: false Reason: Item size was too large. CancellationDate: '2024-02-11T09:14:41.3695207Z' taxData: areTaxesDesignatedByMarketplace: true taxInfoCollection: - itemIndex: 0 sku: '18' priceTags: - identifier: 0a9df101-330c-41ad-a4c7-5a0bd521bc9u isPercentual: false name: Taxes (Magazine Luisa) value: 193 rawValue: 1.93 subscriptionData: SubscriptionGroupId: A64AC73C0FB8693A7ADB4AC69CA4FD5F Subscriptions: - ExecutionCount: 724 PriceAtSubscriptionDate: 100 ItemIndex: 0 Plan: type: RECURRING_PAYMENT frequency: periodicity: DAILY interval: 1 validity: begin: '2024-02-09T09:14:41.3695207Z' end: '2026-02-11T09:14:41.3695207Z' itemMetadata: Items: - Id: '18' Seller: '1' Name: Cat food SkuName: Cat food ProductId: '6' RefId: '105' Ean: '43673557' ImageUrl: http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000 DetailUrl: /catfood/p AssemblyOptions: - Id: vtex.subscription.plan-ana Name: vtex.subscription.plan-ana Required: false InputValues: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 8 Domain: - 4 month - 1 month Composition: {} - Id: vtex.subscription.daily Name: vtex.subscription.daily Required: false InputValues: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 5 Domain: - 1 day Composition: - Id: vtex.subscription.weekly Name: vtex.subscription.weekly Required: false InputValues: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - 1 week - 2 week - 3 week - 4 week Composition: marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: true name: luxstore storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time customData: A message for a gift. commercialConditionData: Commercial conditions information. openTextField: "\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r" invoiceData: address: postalCode: '******000' city: Rio ** ******* state: RJ country: BRA street: Rua *** *****nte number: '***' neighborhood: Bot***** complement: '*** ** *' reference: settleInvoices: - '24382' - '41252' changesAttachment: id: changeAttachment changesData: - reason: The customer wanted to change. discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v502556llux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b callCenterOperatorData: id: CallCenterOperatorAttachment email: sandra.daves@luxstore.com userName: sandraDaves packageAttachment: packages: - items: - itemIndex: 0 quantity: 1 price: 0 description: '001' unitMultiplier: 0 courier: PAC Correios invoiceNumber: '24382' invoiceValue: 1015 invoiceUrl: https://luxstore.com/invoices/24382.pdf issuanceDate: '2024-02-09T10:10:20.5322681+00:00' trackingNumber: TRK-48960684 invoiceKey: CFe35201100063960001504590006629690333214542150 trackingUrl: https://tracking.fastdelivery.com/track/146/TRK-48960684-01/24382 embeddedInvoice: 204 0 INVOICE 15/2/2024 12:00:00 AM 90 type: Input courierStatus: status: ok finished: true deliveredDate: '2024-02-15T10:17:40.5322681+00:00' data: - lastChange: '2024-02-15T10:17:40.5322681+00:00' city: Rio de Janeiro state: RJ description: Carrier received the package createDate: '2024-02-13T10:12:55.5322681+00:00' cfop: '5100' restitutions: Refund: value: 1015 giftCardData: items: - useFreight: false isCompensation: false compensationValue: 0 id: '7060874' quantity: 1 price: 0 description: The size was too big. volumes: 1 EnableInferItems: false paymentData: transactions: - isActive: true transactionId: E4CFCEA1A2BF42AE9A3FAE8ED460CBFE merchantName: luxstore payments: - id: A536832D9B95439DB73A11558B6F2C2C paymentSystem: '2' paymentSystemName: Visa value: 3990 installments: 1 referenceValue: 3990 cardHolder: cardNumber: firstDigits: '444433' lastDigits: '1111' cvv2: '351' expireMonth: '12' expireYear: '2029' url: giftCardId: giftCardName: giftCardCaption: redemptionCode: group: creditCard tid: '65738757' dueDate: 12/29 connectorResponses: authId: '738757' Tid: '65738757' ReturnCode: '200' Message: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: country: BRA street: Brigadeiro Faria Lima Avenue number: '4440' complement: 10th Floor neighborhood: Itaim Bibi postalCode: '04538132' city: São Paulo state: SP giftCards: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Smith addressId: '3206601248910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22630-011 city: Rio de Janeiro state: RJ country: BRA street: Avenida Lúcio Costa number: '126' neighborhood: Barra da Tijuca complement: '10' reference: apartment geoCoordinates: - -43.3373718 - -23.0105873 logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 3000 listPrice: 3000 sellingPrice: 3000 deliveryWindow: deliveryCompany: All CEPs shippingEstimate: 4bd shippingEstimateDate: '2024-03-09T10:13:40.1020453+00:00' slas: - id: Normal name: Normal shippingEstimate: 4bd deliveryWindow: price: 3000 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 10d pickupPointId: 1_store-RJ transitTime: 3d pickupDistance: 0 - id: Express name: Express shippingEstimate: 2bd deliveryWindow: price: 3000 deliveryChannel: pickup-in-point pickupStoreInfo: additionalInfo: Arrive soon address: addressType: pickup receiverName: addressId: VTEX-RJ versionId: entityId: postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: 4th floor reference: geoCoordinates: - -43.18259 - -22.94436 dockId: Take away dock friendlyName: Store Name RJ isPickupStore: true polygonName: '' lockTTL: 10d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 17.473064422607422 shipsTo: - BRA deliveryIds: - courierId: 136769c courierName: Correios dockId: dock_1f95 quantity: 1 warehouseId: warehouse_68d7 accountCarrierName: recorrencia kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 - id: pickup-in-point stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '3206601248910' versionId: entityId: polygonName: '' pickupPointId: transitTime: 3d trackingHints: - trackingId: 701-1947797-1739404_DBA courierName: Amazon Label trackingUrl: https://storeName.vtexcommercestable.com.br/api/integration-amazon/logistic-program/dba/labels?orderId=d9xsHobRJCIWbbub0 trackingLabel: Amazon Label selectedAddresses: - addressType: residential receiverName: Rodrigo Smith addressId: '3206601248910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22630-011 city: Rio de Janeiro state: RJ country: BRA street: Avenida Lúcio Costa number: '126' neighborhood: Barra da Tijuca complement: '10' reference: 4th floor geoCoordinates: - -43.3373718 - -23.0105873 contactInformation: - id: '0' email: contact@email.com firstName: U** lastName: H***** phone: '556196842267' document: 845.134.270-19 documentType: cpf entityId: 5e50b939-2797-4644-afc9-202069cec129 versionId: 9af7b09a-be4c-41a1-b0e9-47c54dd062b4 ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: - id: 2a7acc17-1eb9-4541-8ac6-2776ce9628e6 name: Shipping promo $100 featured: true description: Promotion of the week matchedParameters: Free Shipping: '100' additionalInfo: marketingData: id: marketingData utmSource: fb utmPartner: utm partner name utmMedium: utm medium name utmCampaign: christmas coupon: sale utmiCampaign: ' ' utmipage: ' ' utmiPart: ' ' marketingTags: - vtex-subscription giftRegistryData: giftRegistryId: '154' giftRegistryType: '9' giftRegistryTypeName: Wedding list addressId: '4352357942349' description: Alanna & Daniel clientProfileData: id: clientProfile_6930 email: rodrigo.smith@email.com firstName: Rodrigo lastName: Smith documentType: cpf document: 845.134.270-19 phone: '+5561992227222' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5660c55f-714d-4b14-88a7-b03e9bfbdd2y userProfileVersion: b98d1d7b-4075-4d88-81e5-418d36b078g3 customerClass: customerCode: 933d29f5-c7c5-4d12-b0c8-c30079c33b21 items: - uniqueId: 94913BB553334977BFD669A24E678C69 id: '18' productId: '6' ean: '3256873' lockId: 00-1415461749731-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGBML price: 990 listPrice: 1990 manualPrice: priceTags: [] imageUrl: https://luxstore.img.com.br/ids/155392-55-55/KOI.jpg?v=6359184022286 detailUrl: /bay-max-9429485/p components: [] bundleItems: - id: 12 quantity: 2 params: [] offerings: [] attachmentOfferings: - name: luxstore.subscription.weekly required: false schema: luxstore.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - 1 week - 2 week - 3 week - 4 week sellerSku: '18' priceValidUntil: '2025-03-05T10:13:09.0000000+00:00' commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: Lux Brand brandId: '2000000' categoriesIds: /9/ categories: - id: 9 name: Coach productClusterId: '135' commercialConditionId: '1' dimension: cubicweight: 1 height: 10 length: 10 weight: 10 width: 10 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 990 isGift: false shippingPrice: rewardValue: 1599 freightCommission: 0 priceDefinition: sellingPrices: - value: 990 quantity: 1 calculatedSellingPrice: 990 total: 990 reason: taxCode: product_Free parentItemIndex: 0 parentAssemblyBinding: assembly_product_warranty callCenterOperator: serialNumbers: assemblies: [] costPrice: 520 marketplaceItems: [] deprecated: false /api/oms/pvt/orders: get: tags: - Orders summary: VTex List orders description: "Retrieves a list of orders according to the filters described below. \r\n\r\nThe limit of information retrieval is 30 pages, the default number of orders per page is 15 and it is possible to configure it up to 100 using the `per_page` parameter. \r\n\r\nBe aware that since October 3rd, 2018, this endpoint does not return the `items` property. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> This endpoint should **not** be used for integrations. Use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed) for this purpose. \r\n\r\nThis endpoint returns only orders that already have been indexed, which takes approximately four minutes. Because of this, the data retrieved may present inconsistencies. To get live up-to-date information and [build order integrations](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration) use the [orders Feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n> **Onboarding guide** \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **List Orders** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | List Orders |\r\n| Checkout Admin | List Orders |\r\n| IntegrationProfile - Fulfillment Oms | List Orders |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: ListOrders parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderBy in: query description: "You can retrieve orders lists filtering by an `OrderField` combined with an `OrderType`. To do so, you have to concatenate them: `orderBy={{OrderField}},{{OrderType}}`. \r\n- `OrderField` values accepted: `creationDate`, `orderId`, `items`, `totalValue` and `origin`. \r\n- `OrderType` values accepted: `asc` and `desc`." required: false style: form explode: true schema: type: string example: v502556llux-01,asc - name: page in: query description: Define the number of pages you wish to retrieve, restricted to the limit of 30 pages. required: false style: form explode: true schema: type: integer example: 10 - name: per_page in: query description: Quantity of orders for each page, the default value is 15 and it goes up to 100 orders per page. Be aware that the limit of retrieval ofthis endpoint is 30 pages. required: false style: form explode: true schema: type: integer example: 15 - name: f_hasInputInvoice in: query description: Filters list to return only orders with non `null` values for the `invoiceInput` field. required: false style: form explode: true schema: type: boolean example: false - name: q in: query description: "This parameter filters using Fulltext and accepts the values below. Be aware that the `+` caracter is not allowed in Fulltext Search. \r\n- Order Id \r\n- Client email \r\n- Client document \r\n- Client name" required: false style: form explode: true schema: type: string example: "- OrderID: v212333lux-02 \r\n- Client email: taylor@email.com \r\n- Client document: 21133355524 \r\n- Client name: Taylor" - name: f_shippingEstimate in: query description: "You can filter orders by shipping estimate time in days by concatenating the desired number of days with the sufix `.days`. For example: \r\n- Next 7 days: `7.days` \r\n- Tomorrow: `1.days` \r\n- Today: `0.days` \r\n- Late: `-1.days`" required: false style: form explode: true schema: type: string example: 0.days - name: f_invoicedDate in: query description: "You can filter orders by invoiced date by concatenating the sufix `invoicedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" required: false style: form explode: true schema: type: string example: invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z] - name: f_creationDate in: query description: "You can filter orders by creation date by concatenating the sufix `creationDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" required: false style: form explode: true schema: type: string example: creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z] - name: f_authorizedDate in: query description: "You can filter orders by creation date by concatenating the sufix `authorizedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" required: false style: form explode: true schema: type: string example: creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z] - name: f_UtmSource in: query description: You can filter orders by Urchin Tracking Module (UTM) source. required: false style: form explode: true schema: type: string example: christmas_campaign - name: f_sellerNames in: query description: You can filter orders by using a seller's name. required: false style: form explode: true schema: type: string example: SellerName - name: f_callCenterOperatorName in: query description: You can filter orders by using a Call Center Operator's identification. required: false style: form explode: true schema: type: string example: Operator%20Name - name: f_salesChannel in: query description: You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) name. required: false style: form explode: true schema: type: string example: Main - name: salesChannelId in: query description: You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID. required: false style: form explode: true schema: type: string example: '1' - name: f_affiliateId in: query description: You can filter orders by affiliate ID. required: false style: form explode: true schema: type: string example: WLM - name: f_status in: query description: "You can filter orders by the following [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196): \r\n- `waiting-for-sellers-confirmation` \r\n- `payment-pending` \r\n- `payment-approved` \r\n- `ready-for-handling` \r\n- `handling` \r\n- `invoiced` \r\n- `canceled`" required: false style: form explode: true schema: type: string example: ready-for-handling - name: incompleteOrders in: query description: When set as `true`, you retrieve [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders), when set as `false`, you retrieve orders that are not incomplete. required: false style: form explode: true schema: type: boolean example: true - name: f_paymentNames in: query description: You can filter orders by payment type. required: false style: form explode: true schema: type: string example: Visa - name: f_RnB in: query description: You can filter orders by rates and benefits (promotions). required: false style: form explode: true schema: type: string example: Free+Shipping - name: searchField in: query description: "You can search orders by using one of the following criterias: \r\n- SKU ID - `sku_Ids&sku_Ids` \r\n- Gift List ID - `listId&listId` \r\n- Transaction ID (TID) - `tid&tid` \r\n- PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r\n- Payment ID (PID) - `paymentId&paymentId` \r\n- Connector's NSU - `nsu&nsu`" required: false style: form explode: true schema: type: string example: "- SKU ID: `25` \r\n- Gift List ID: `11223` \r\n- Transaction ID (TID): `54546300238810034995829230012` \r\n- PCI Connector's Transaction ID (TID): `7032909234899834298423209` \r\n- Payment ID (PID): `2` \r\n- Connector's NSU: `2437281`" - name: f_isInstore in: query description: When set as `true`, this parameter filters orders made via [inStore](https://help.vtex.com/en/tracks/what-is-instore--zav76TFEZlAjnyBVL5tRc), and when set as `false`, it filters orders that were not made via inStore. required: false style: form explode: true schema: type: boolean example: true responses: '200': description: OK headers: Cache-Control: content: text/plain: schema: type: string example: no-cache Connection: content: text/plain: schema: type: string example: close Content-Encoding: content: text/plain: schema: type: string example: gzip Date: content: text/plain: schema: type: string example: Mon, 13 Feb 2017 15:25:12 GMT Expires: content: text/plain: schema: type: string example: '-1' Pragma: content: text/plain: schema: type: string example: no-cache Server: content: text/plain: schema: type: string example: nginx Vary: content: text/plain: schema: type: string example: Accept-Encoding X-CDNIgnore: content: text/plain: schema: type: string example: '1' X-Powered-by-VTEX-Janus-Edge: content: text/plain: schema: type: string example: v1.35.3 X-Track: content: text/plain: schema: type: string example: stable X-VTEX-Janus-Router-Backend-App: content: text/plain: schema: type: string example: omsapi-v1.5.135 content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ListOrders' example: list: - orderId: 1306331686122-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502554' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide' ShippingEstimatedDate: '2019-01-31T12:36:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502551' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:40:55+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502548' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:35:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502544' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502541' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2018-12-19T18:22:26+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880102018018-01 sequence: '502537' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'cancelamento teste shp ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880091058221-01 sequence: '502535' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'Teste de cancelamento do ShopFácil ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 880090643370-01 sequence: '502534' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 876733475998-01 sequence: '502531' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL facets: [] paging: total: 84 pages: 6 currentPage: 1 perPage: 15 stats: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: deprecated: false /api/oms/pvt/orders/{orderId}/start-handling: post: tags: - Orders summary: VTex Start handling order description: "Changes the status of an order to indicate that it is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the `204` code, making this flow the store's responsibility. This endpoint can also respond with `status 500`. \n\r\n\r> The `Change order workflow status` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#)." operationId: StartHandling parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. required: true style: simple schema: type: string example: 1172452900788-01 example: 1172452900788-01 responses: '204': description: '[No content](https://httpstatuses.com/204)' '401': description: '[Unauthorized](https://httpstatuses.com/401)' content: application/json: schema: type: object description: Root object properties: error: title: error description: Object containing the error information. type: object properties: code: title: code description: Error code in the Order Management System. type: string example: OMS003 message: title: message description: Error message. type: string example: Acesso não autorizado exception: title: exception description: Exception. type: string example: nullable: true example: error: code: '1' message: Acesso não autorizado exception: '403': description: '[Forbidden](https://httpstatuses.com/403)' '404': description: '[Not found](https://httpstatuses.com/404)' '409': description: '[Conflict](https://httpstatuses.com/409)' content: application/json: schema: type: object description: Root object properties: error: title: error description: Object containing the error information. type: object properties: code: description: Error code in the Order Management System. type: string message: description: Error message. type: string exception: description: Exception. type: string nullable: true example: error: code: OMS003 message: Order status should be ready-for-handling to perform this action exception: '429': description: '[Too many requests](https://httpstatuses.com/429)' deprecated: false /api/oms/pvt/orders/{orderId}/cancel: post: tags: - Orders summary: VTex Cancel order description: "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: CancelOrder parameters: - name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: ID that identifies the order in the seller. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 requestBody: content: application/json: schema: type: object properties: reason: type: string description: Reason for cancelling the order. example: Unexpected stock shortage responses: '200': description: OK content: application/json: schema: type: object properties: date: type: string description: Date and time when the notification was received. orderId: type: string description: Identification of the order in the seller. receipt: type: string description: Protocol code generated by the update. It may be `null`. example: date: '2014-02-07T15:22:56.7612218-02:00' orderId: '123543123' receipt: 38e0e47da2934847b489216d208cfd91 '403': description: The credentials are not enabled to access the service. '404': description: Value not found. '429': description: Too many requests. deprecated: false /api/oms/pvt/orders/{orderId}/changes: post: tags: - Orders summary: VTex Register change on order description: "This request allows [changing an order](https://help.vtex.com/en/tutorial/changing-items-from-a-completed-order--tutorials_190) by:\r\n\r\n- Adding items to an order.\r\n\r\n- Removing items from an order.\r\n\r\n- Applying discounts to the total value of the order.\r\n\r\n- Incrementing the total value of the order. \r\n\r\n> **Timeout settings:** This is a synchronous API, which means the application requests data and waits until a value is returned. This behavior can cause timeout errors. To avoid them, we recommend setting the timeout in 20 seconds.\r\n\r\nIn change order scenarios, it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a partial invoice scenario. The updated value is settled by the VTEX Payment Gateway, and the customer reimbursement is automatic. \r\n\r\nThis action can only be done for orders in the following status:\r\n\r\n- `handling`\r\n\r\n- `waiting-for-fulfillment` \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." operationId: RegisterChange parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: ID that identifies the order in the seller. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterChangeRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RegisterChange' example: date: '2024-02-08T13:54:33.6868469+00:00' orderId: v502538llux-01 receipt: 535d4581-a2a2-4fd2-a206-1c61eae91b1e deprecated: false /api/oms/pvt/orders/{orderId}/interactions: post: tags: - Orders summary: VTex Add log in orders description: Add a Log in Interactions Order Array. operationId: AddLog parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Unique code that identifies an order. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 description: Unique code that identifies an order. requestBody: content: application/json: schema: $ref: '#/components/schemas/AddLogRequest' example: source: Postman message: Teste add interactions required: true responses: '200': description: OK deprecated: false /api/oms/pvt/orders/{orderId}/invoice: post: tags: - Invoice summary: VTex Order invoice notification description: "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to the `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \r\n\r\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \r\n\r\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \r\n\r\n## Partial invoices \r\n\r\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \r\n\r\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \r\n\r\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \r\n\r\n## Returning items \r\n\r\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \r\n\r\n- `output`: selling order invoice. \r\n\r\n- `input`: returning items invoice. \r\n\r\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \r\n\r\n## Changing the receipt code \r\n\r\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\r\n\r\n## Integration with marketplaces \r\n\r\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \r\n\r\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Notify invoice** |\r\n| OMS | OMS access | **Notify refund** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: InvoiceNotification parameters: - name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Unique code that identifies the order whose invoice is being sent. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceNotificationRequest' required: true responses: '200': description: OK content: application/json: schema: type: object properties: date: type: string description: Date and time when the notification was received. orderId: type: string description: Identification of the order in the seller. receipt: type: string description: Protocol code generated by the update that identifies the receipt. Every time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. example: date: '2014-02-07T15:22:56.7612218-02:00' orderId: '123543123' receipt: 38e0e47da2934847b489216d208cfd91 deprecated: false /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}: patch: tags: - Invoice summary: VTex Update order's partial invoice (send tracking number) description: "Update a given order, adding its tracking number to its [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe).\n\r\n\rAfter using this call to add a tracking number to an order, you can use the [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) API request to add tracking events.\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc)." operationId: Updatepartialinvoice.SendTrackingNumber parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Unique code that identifies the order whose invoice is being sent. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 - name: invoiceNumber in: path description: Number that identifies the invoice. example: '000030711' required: true style: simple schema: type: string example: '000030711' requestBody: content: application/json: schema: $ref: '#/components/schemas/Updatepartialinvoice.SendTrackingNumber.Request' example: trackingNumber: '87658' trackingUrl: https://www.tracking.com/url courier: carrierOne dispatchedDate: '2022-02-08T13:16:13.4617653+00:00' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Updatepartialinvoice.SendTrackingNumber' example: date: '2019-02-08T13:16:13.4617653+00:00' orderId: 00-v5195004lux-01 receipt: 527b1ae251264ef1b7a9b597cd8f16b9 deprecated: false /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking: put: tags: - Tracking summary: VTex Update order tracking status description: "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\r\n\r\nThis request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the [Update order's partial invoice](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-) endpoint. For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\r\n\r\nThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n> The `Notify invoice` License Manager resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about [License Manager Roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc)." operationId: UpdateTrackingStatus parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 - name: invoiceNumber in: path description: Number that identifies the invoice. example: '000030711' required: true style: simple schema: type: string example: '000030711' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTrackingStatusRequest' example: isDelivered: false deliveredDate: 2022-10-01 21:15 events: - city: Rio de Janeiro state: RJ description: Coletado pela transportadora date: '2015-06-23' - city: Sao Paulo state: SP description: A caminho de Curitiba date: '2015-06-24' required: true responses: '200': description: OK headers: Cache-Control: content: text/plain: schema: type: string example: no-cache Connection: content: text/plain: schema: type: string example: keep-alive Content-Length: content: text/plain: schema: type: string example: '116' Date: content: text/plain: schema: type: string example: Wed, 29 Mar 2017 18:05:00 GMT Expires: content: text/plain: schema: type: string example: '-1' Pragma: content: text/plain: schema: type: string example: no-cache Server: content: text/plain: schema: type: string example: nginx X-CDNIgnore: content: text/plain: schema: type: string example: '1' X-Powered-by-VTEX-Janus-Edge: content: text/plain: schema: type: string example: v1.35.3 X-Track: content: text/plain: schema: type: string example: stable X-VTEX-Janus-Router-Backend-App: content: text/plain: schema: type: string example: omsapi-v1.5.143 content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/UpdateTrackingStatus' example: date: '2017-03-29T18:04:31.0521233+00:00' orderId: v501245lspt-01 receipt: f67d33a8029c42ce9a8f07fc17f54449 deprecated: false /api/oms/pvt/orders/{orderId}/conversation-message: get: tags: - Conversation summary: VTex Retrieve order conversation description: List all order conversations of an order by its order ID. operationId: GetConversation parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. required: true example: 1172452900788-01 style: simple schema: type: string example: 1172452900788-01 responses: '200': description: OK headers: Cache-Control: content: text/plain: schema: type: string example: no-cache Connection: content: text/plain: schema: type: string example: close Content-Encoding: content: text/plain: schema: type: string example: gzip Date: content: text/plain: schema: type: string example: Mon, 13 Feb 2017 15:25:24 GMT Expires: content: text/plain: schema: type: string example: '-1' Pragma: content: text/plain: schema: type: string example: no-cache Server: content: text/plain: schema: type: string example: nginx Vary: content: text/plain: schema: type: string example: Accept-Encoding X-CDNIgnore: content: text/plain: schema: type: string example: '1' X-Powered-by-VTEX-Janus-Edge: content: text/plain: schema: type: string example: v1.35.3 X-Track: content: text/plain: schema: type: string example: stable X-VTEX-Janus-Router-Backend-App: content: text/plain: schema: type: string example: omsapi-v1.5.135 content: application/json; charset=utf-8: schema: type: array items: $ref: '#/components/schemas/GetConversation' example: - id: 2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3 from: conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: noreply@vtexcommerce.com.br-9814872b.ct.store.com.br aliasMaskType: 0 email: noreply@store.com.br name: no reply role: 'null' to: - conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br aliasMaskType: 0 email: customer.name@email.com name: Mary John role: Customer subject: Your payment has been aproved. firstWords: Your payment has been aproved and we are waiting for... body: ' recorrenciaqa

Seu pagamento foi aprovado.

Referente ao Pedido #1305371685465-01

Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.

Pagamento

Visa final 1111
R$ 3,99 à vista

Atenciosamente,
Equipe recorrenciaqa

' hasAttachment: false attachmentNames: - attachments439505 date: '2023-01-23T09:23:31.0000000+00:00' deprecated: false /api/oms/pvt/orders/{orderId}/payment-transaction: get: tags: - Payment summary: VTex Retrieve payment transaction description: |- Retrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. In scenarios of [order changes](https://developers.vtex.com/vtex-rest-api/reference/registerchange), it is possible to insert a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe). The total value of the order will be updated after the insertion of the invoice, even when there is a [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenario. The updated value is settled by VTEX's Payment Gateway. The reimbursement for the shopper is automatic. operationId: GetPaymenttransaction parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetPaymenttransaction' example: status: Finished isActive: true transactionId: CB452D77E7D04099A4DB0479087B1D2C merchantName: LUXSTORE payments: - id: 721CBE1090324D12ABE301FE33DE775A paymentSystem: '4' paymentSystemName: Mastercard value: 10150 installments: 1 referenceValue: 10150 cardHolder: cardNumber: firstDigits: '412341' lastDigits: '4123' url: giftCardId: giftCardName: cvv2: expireMonth: expireYear: giftCardCaption: redemptionCode: group: creditCard tid: '101770752' dueDate: connectorResponses: Tid: '101770752' ReturnCode: '200' Message: logMessage authId: '170852' deprecated: false /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification: post: tags: - Payment summary: VTex Send payment notification description: "Send a payment notification of a given order, by order ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#)." operationId: SendPaymentNotification parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. example: 1172452900788-01 required: true style: simple schema: type: string example: 1172452900788-01 - name: paymentId in: path description: VTEX payment identifier. example: F5C1A4E20D3B4E07B7E871F5B5BC9F91 required: true style: simple schema: type: string example: F5C1A4E20D3B4E07B7E871F5B5BC9F91 responses: '200': description: OK '400': description: Bad request. '403': description: The credentials are not enabled to access the service. '404': description: Value not found. '429': description: Too many requests. deprecated: false /api/oms/pvt/feed/orders/status: get: tags: - Feed V2 (Deprecated) summary: VTex Get feed order status description: Get feed order status (deprecated) operationId: Getfeedorderstatus parameters: - name: maxLot in: query description: Maximum lot. required: true style: form explode: true schema: type: string example: '{{maxLot}}' - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent required: true style: simple schema: type: string default: application/json responses: '200': description: OK headers: {} deprecated: false /api/orders/feed/config: get: tags: - Feed V3 summary: VTex Get feed configuration description: "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n" operationId: GetFeedConfiguration parameters: - name: Content-Type in: header description: Type of the content being sent required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand required: true style: simple schema: type: string default: application/json responses: '200': description: OK content: application/json: schema: type: object properties: filter: type: object description: Information on how orders are filtered to show on the feed. properties: type: type: string description: Determines what orders appear in the feed and how they are filtered. If a feed has the `FromWorkflow` type configuration, it will receive order updates only when order’s statuses change and orders can be filtered by status, using the `status` field. A feed with the `FromOrders` type configuration gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions set in the `expression` field. status: type: array description: List of order statuses that should be included in the feed. This should only be used in case `type` is `FromWorkflow`. items: type: string description: Order status to be filtered in the feed. expression: type: string description: JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is `FromOrders`. disableSingleFire: type: boolean description: Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once. queue: type: object description: Information that define the functioning of the queue. properties: visibilityTimeoutInSeconds: type: integer description: Period of time for which an item is not visible in the feed after it has been retrieved with the Get feed items request. Measured in seconds. MessageRetentionPeriodInSeconds: type: integer description: Maximum life span of an order update after it gets to the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds. quantity: type: integer description: Current number of messages in the feed, including messages that may not be visible due to time out after retrieval. approximateAgeOfOldestMessageInSeconds: type: number description: Aproximate age of the oldest message in the feed, measured in seconds. example: filter: type: FromOrders expression: status = "payment-pending" disableSingleFire: false queue: visibilityTimeoutInSeconds: 240 messageRetentionPeriodInSeconds: 345600 deprecated: false post: tags: - Feed V3 summary: VTex Create or update feed configuration description: "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration)\n\r\n\rThere are two types of filtering that can be used. The `FromWorkflow` type filters orders by status, whereas the `FromOrders` type uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata) endpoint." operationId: FeedConfiguration parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedConfigurationRequest' example: filter: type: FromOrders expression: value > 100 disableSingleFire: false queue: visibilityTimeoutInSeconds: 250 MessageRetentionPeriodInSeconds: 345600 required: true responses: '200': description: Success '403': description: The credentials are not enabled to access the service '404': description: Value not found '429': description: Too many requests deprecated: false delete: tags: - Feed V3 summary: VTex Delete feed configuration description: Deletes the configuration set up in [Feed v3](https://developers.vtex.com/docs/guides/orders-feed). operationId: FeedConfigurationDelete parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: OK '400': description: Bad request - Unable to check address / Only https scheme is accepted '403': description: The credentials are not enabled to access the service '404': description: Value not found '429': description: Too many requests deprecated: false /api/orders/feed: get: tags: - Feed V3 summary: VTex Retrieve feed items description: "Retrieve items from [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. \n\r\nThe event will be removed if the message `send retry` is equal to, or greater than the maximum retention period.\r\n\r\n> This API will return `404 Not Found` if there is no [Feed Configuration](https://developers.vtex.com/docs/guides/orders-feed) available for the given X-VTEX-API-AppKey." operationId: Getfeedorderstatus1 parameters: - name: maxlot in: query description: Lot quantity to retrieve. Maximum accepted value is 10. required: true style: form explode: true schema: type: string example: '{{maxLot}}' - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent required: true style: simple schema: type: string default: application/json responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Getfeedorderstatus' example: - eventId: ED423DDED4C1AE580CADAC1A4D02DA3F handle: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoidnRleGFwcGtleS1wYXJ0bmVyc2xhdGFtLVJNQkpNUyIsIkFwcEtleSI6InZ0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMiLCJBY2NvdW50IjoicGFydG5lcnNsYXRhbSIsIkhhbmRsZSI6IkFRRUIzbmtWR0piOXhhNGRjYlpkOTFVVWMyL2JObHc0Qnp3ZlNLV201Rjg2QXgrSGlRM053bEJkb2NwM2wvVytLdjFNQTZ4d3ZLcFYwYjlSeUttNVRpb3hrSVFMSG1Uck9xenB2aFlwU29uMzRrVmlNaWZHY2lnZFFqalBJdk00eWU4amVuaS9QKytaTmVxOFZWeFNGay81Yzg3YS84MTRjTFg2WGZPR2x2WitlTnVjTzA3S3UxK0xXaU5vQmJEY0cycGxKekxkRks3Qld3b1NTV3BmSWhrOGhmSFNkSzlzZVpJeG01QXFLbHFrUHNDNGk5emVaYVpBUVVrSi9aZWo3UjRrRDVRaXFjNmpjcnFheEdHc1lsNHMzUWM0ZmtWdmhYblJVQ2l2ZGdpMEtUYS8zcXlWWU9QTktIV2huTlZxMEZHNDNjME4vaWh6dDc0d1laNVl6aDFJRitHU2t1YTkrN1pCdnQ2VGs1cFRhZmVVclk0ckNPL2Fobnl1eXFLOG53ZkorVWxUTmt2ZVNFS29FdTNiUWQzSmc5R1lYWHlXOVVxRGo5dHJIZ1N5M3ZZa0dBWjd0MDZNZWUwQnBsdFBxWExaIiwiT3JkZXJJZCI6Ijk1MzcxMjAwNDEyNi0wMSIsIk1lc3NhZ2VJZCI6ImI5YjI4NDkwLTNjNzAtNDdjNi1hMTE3LWNhN2FjMTk2MDY1OSIsIkRvbWFpbiI6IkZ1bGZpbGxtZW50IiwiU3RhdGUiOiJyZWFkeS1mb3ItaGFuZGxpbmciLCJMYXN0U3RhdGUiOiJ3aW5kb3ctdG8tY2FuY2VsIiwiTGFzdENoYW5nZSI6IjA4LzEyLzIwMTkgMjA6NTQ6MDEiLCJDdXJyZW50Q2hhbmdlIjoiMDgvMTIvMjAxOSAyMDo1NDoyMyIsIkNyZWF0ZWRBdCI6IjA4LzEyLzIwMTkgMjE6MDE6MzAiLCJpc3MiOiJicm9hZGNhc3QtYXBpLnZ0ZXhjb21tZXJjZS5jb20uYnIiLCJhdWQiOiJwYXJ0bmVyc2xhdGFtX3Z0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMifQ.7RQBZQb6pHhFhA_jMKTiSoJbDck7awgD3Xx7sdJcW6w domain: Fulfillment state: ready-for-handling lastState: window-to-cancel orderId: 953712004126-01 lastChange: '2019-08-12T20:54:01.134057Z' currentChange: '2019-08-12T20:54:23.7153839Z' deprecated: false post: tags: - Feed V3 summary: VTex Commit feed items description: Commit items in the [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. operationId: Commititemfeedorderstatus parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/CommititemfeedorderstatusRequest' example: handles: - AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE= required: true responses: '200': description: OK content: text/plain: schema: type: object deprecated: false /api/orders/hook/config: get: tags: - Order Hook summary: VTex Get hook configuration description: "Retrieves a given hook's configuration details. Learn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook). \r\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n" operationId: GetHookConfiguration parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: clientEmail in: query description: Customer email. required: false style: form explode: true schema: type: string example: customer@mail.com - name: page in: query description: Page number for result pagination. required: false style: form explode: true schema: type: string example: '10' - name: per_page in: query description: Page quantity for result pagination. required: false style: form explode: true schema: type: string example: '15' responses: '200': description: OK headers: {} deprecated: false post: tags: - Order Hook summary: VTex Create or update hook configuration description: "Configures filtering rules applied to orders hook. Learn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook).\n\r\n\rThere are two types of filtering that can be used: \n\r\n\r - `FromWorkflow`: filters orders by status.\n\r\n\r - `FromOrders`: uses JSONata expressions to filter orders according to any property in the orders JSON document.\n\r\n\r This enables stores to filter delivered orders and orders in which products have been added or removed, for example.\n\r\n\rTo learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [expressions API](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)." operationId: HookConfiguration parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/HookConfigurationRequest' example: filter: type: FromOrders expression: value > 100 disableSingleFire: false hook: url: https://endpoint.example/path headers: key: value required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/HookConfiguration' example: Domain: Fulfillment OrderId: v52277740atmc-01 State: ready-for-handling LastState: window-to-cancel LastChange: '2019-08-14T17:11:39.2550122Z' CurrentChange: '2019-08-14T17:12:48.0965893Z' Origin: Account: automacaoqa Key: vtexappkey-appvtex deprecated: false delete: tags: - Order Hook summary: VTex Delete hook configuration description: "Deletes a given hook configuration.\n\r\n\rLearn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook)." operationId: DeleteHookConfiguration parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: Success '403': description: The credentials are not enabled to access the service '404': description: Value not found '429': description: Too many requests deprecated: false /api/oms/user/orders: get: tags: - User Orders summary: VTex Retrieve user's orders description: "Lists all orders from a given customer, filtering by their email. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Call center operator | View order |\r\n| OMS - Read only | View order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: Userorderslist parameters: - name: clientEmail in: query description: Customer email. required: true style: form explode: true schema: type: string example: customer@mail.com - name: page in: query description: Page number for result pagination. required: true style: form explode: true schema: type: string example: '15' - name: per_page in: query description: Page quantity for result pagination. required: true style: form explode: true schema: type: string example: '15' - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Userorderslist' example: list: - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502449llux-02 creationDate: '2018-08-28T17:42:40+00:00' clientName: Cunha VTEX items: totalValue: 118588 paymentNames: Promissory status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502452' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502449llux-02 Resumo Itens R$ 1.178,98 Entrega R$ 6,90 Total R$ 1.185,88' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 12 currencyCode: BRL - orderId: v502449llux-01 creationDate: '2018-08-28T17:42:28.9171556+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Mangueira Filtro ean: refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 21526180 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '502449' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v502058llux-01 creationDate: '2017-07-25T23:17:36.7963248+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Aquecedor Britania 1500 Branco ean: '1235567890143' refId: branquinho id: '1234568212' productId: '1000200' sellingPrice: 35599 price: 35599 totalValue: 35599 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '502058' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2017-07-29T19:24:20.7444363+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v501538llux-01 creationDate: '2017-06-26T16:57:58.9986524+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Boneco do Mário ean: bonecomario refId: bonecomario id: '1234568183' productId: '1000257' sellingPrice: 150363 price: 150363 - seller: '1' quantity: 1 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 151262 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '501538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2017-06-27T13:59:49.7705236+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v501020llux-01 creationDate: '2016-11-21T19:57:54.0415289+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 2 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 3190 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '501020' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-12-02T08:00:00+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500973llux-01 creationDate: '2016-10-10T17:19:30.8562035+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1" 4G CÂMERA 12 MP ean: refId: testefnac id: '1234568028' productId: '1000203' sellingPrice: 299000 price: 299000 totalValue: 299900 paymentNames: status: handling statusDescription: Preparando Entrega marketPlaceOrderId: '' sequence: '500973' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-10-10T14:23:17.1897068+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500970llux-01 creationDate: '2016-10-10T17:07:59.0889392+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 1799 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '500970' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-10-10T14:13:34.4927265+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500890llux-01 creationDate: '2016-08-17T18:35:04.8659804+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M ean: absolutm refId: id: '549' productId: '9' sellingPrice: 1000 price: 1000 totalValue: 1000 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500890' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500838llux-01 creationDate: '2016-07-29T00:20:47.7736718+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Rooibos Lavanda - Pouch - 50gr ean: '198' refId: '10098' id: '98' productId: '1000025' sellingPrice: 5200 price: 5200 totalValue: 6200 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500838' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: facets: [] paging: total: 19 pages: 10 currentPage: 1 perPage: 2 stats: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} deprecated: false /api/oms/user/orders/{orderId}: get: tags: - User Orders summary: VTex Retrieve user order details description: "Lists all details from an order, through the perspective of the customer who placed the order. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Call center operator | View order |\r\n| OMS - Read only | View order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: Userorderdetails parameters: - name: clientEmail in: query description: Customer email. required: true style: form explode: true schema: type: string example: customer@mail.com - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. required: true style: simple schema: type: string example: 1172452900788-01 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Userorderdetails' example: orderId: 1172452900788-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v502556llux-01 origin: Marketplace affiliateId: GHB salesChannel: '1' merchantName: luxstore status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: v502556lspt totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: '3256873' lockId: 00-v502556llux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - 1 week - ' 2 week' - ' 3 week' - ' 4 week' sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: parentItemIndex: parentAssemblyBinding: callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: Cunha documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: giftRegistryData: marketingData: id: marketingData utmSource: fb utmPartner: utm partner name utmMedium: utm medium name utmCampaign: christmas coupon: sale utmiCampaign: ' ' utmipage: ' ' utmiPart: ' ' marketingTags: - vtex-subscription ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '518' neighborhood: Botafogo complement: '10' reference: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: pickupPointId: 1_VTEX-RJ transitTime: 3d trackingHints: selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: geoCoordinates: [] paymentData: giftCards: [] transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} packageAttachment: packages: [] sellers: - id: '1' name: Lux Store logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName callCenterOperatorData: followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: hostname: luxstore invoiceData: changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v502556llux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: isCompleted: true customData: storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: true allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: cancelReason: The size was too big. itemMetadata: Items: - Id: '18' Seller: '1' Name: Cat food SkuName: Cat food ProductId: '6' RefId: '105' Ean: '43673557' ImageUrl: http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000 DetailUrl: /catfood/p AssemblyOptions: - Id: vtex.subscription.plan-ana Name: vtex.subscription.plan-ana Required: false InputValues: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 8 Domain: - 4 month - 1 month Composition: {} subscriptionData: SubscriptionGroupId: A64AC73C0FB8693A7ADB4AC69CA4FD5F Subscriptions: - ExecutionCount: 724 PriceAtSubscriptionDate: 100 ItemIndex: 0 Plan: type: RECURRING_PAYMENT frequency: periodicity: DAILY interval: 1 validity: begin: '2022-01-10T00:00:00.0000000+00:00' end: '2024-02-03T00:00:00.0000000+00:00' taxData: areTaxesDesignatedByMarketplace: true taxInfoCollection: - itemIndex: 0 sku: COLOCAR_O_SKUID priceTags: - isPercentual: false name: Taxes (Magazine Luisa) rawValue: COLOCAR_O_VALOR_SEM_DECIMAL checkedInPickupPointId: storeNameExample_901 cancellationData: RequestedByUser: true RequestedBySystem: false RequestedBySellerNotification: false RequestedByPaymentNotification: false Reason: Item was too big in the client. CancellationDate: 2022-10--05T15:40:33 clientPreferencesData: locale: en-US optinNewsLetter: false deprecated: false /api/orders/expressions/jsonata: post: tags: - Feed V3 summary: VTex Test JSONata expression description: "This endpoint allows you to test a JSON document with a JSONata expression, returning `true` if the document meets the criteria posed in the expression, or `false` if it does not.\n\r\n\rSince JSONata expressions can be used to filter order updates in the [Orders API feed and hook](https://developers.vtex.com/docs/guides/orders-feed), this endpoint can be used to test an expression's results before configuring the [feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\n\r\n\rLearn more about how to use JSONata expressions, in the [JSONata documentation](https://docs.jsonata.org/overview.html)." operationId: TestJSONataExpression parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Type of the content being sent required: true style: simple schema: type: string default: application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/TestJSONataExpression' example: Expression: status = \"canceled\" Document: '{\"status\":\"canceled\"}' responses: '200': description: OK content: text/plain: examples: response: value: 'True' deprecated: false /api/checkout/pvt/configuration/window-to-change-seller: get: tags: - Change Seller summary: VTex Get window to change seller description: "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller." operationId: GetWindowToChangeSeller parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json responses: '200': description: OK content: text/plain: schema: type: integer description: Window to change seller measured in days. examples: response: value: 2 deprecated: false post: tags: - Change Seller summary: VTex Update window to change seller description: "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller." operationId: UpdateWindowToChangeSeller parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json requestBody: content: application/json: schema: type: object required: - waitingTime properties: waitingTime: type: integer description: Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order. example: waitingTime: 4 required: true responses: '201': description: Created headers: {} deprecated: false /api/order-system/orders/{changeOrderId}/changes: patch: tags: - Change Order (Beta) summary: VTex Create order change operationId: Createchange description: "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) feature allows you to modify an order, whether the change is motivated by customer mistakes, product unavailability, or others. Both sellers and marketplaces can use this endpoint and change orders in multiple scenarios, and it is possible to make a single change or combine multiple ones in the same request. \r\nThe possible change order operations you can perform are the following:\r\n- **Add:** Adding items, quantity, or product weight.\r\n- **Remove:** Removing a part of items or the total quantity.\r\n- **Replace:** Changing items' quantity, weight, or price. You can also replace one or more items with different ones, including weighable products.\r\n\r\n>❗ When removing or adding items to an order, your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) is not automatically updated. You can use the [Update inventory by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.\r\n\r\nThe next sections are listed below:\r\n- Number of changes per order \r\n- Acceptable order status for changes \r\n- Order change and price \r\n- Combining multiples operations \r\n\r\n## Number of changes per order\r\nBesides being able to combine multiple change operations - add, remove, and replace - in a single request, you can make different change requests, and there is no limit to how many times an order can be changed.\r\n\r\nEach order has its change history, you can retrieve it using the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Acceptable order status for changes\r\nYou can only change an order when it is one of the following [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) status:\r\n- `handling`\r\n- `waiting-for-fulfillment` \r\n- `ready for invoicing` \r\n\r\nIt is not possible to change an order when the payment transaction is complete.\r\n\r\n## Order change and price\r\nWhen you add, remove or replace items using this endpoint, the order and payment transaction values are automatically updated. Change order calculates the update of the following values:\r\n- Item value\r\n- Total value \r\n\r\n**Example:** If you send the request body for replacing items without the unit multiplier (`unitMultiplier`) or measurement (`measurementUnit`), Change order will get this information on your store's Catalog, Pricing and Payment systems. \r\n>⚠️ Increasing the price of an order is allowed only when the order was paid by credit card, [payable notes](https:/help.vtex.com/en/tutorial/setting-up-payments-with-promissory--5pW7avTwtyQcMu4uiW8quQ), cash, or [credit control](https:/help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0). In addition, the [acquirer](https:/help.vtex.com/en/tutorial/what-is-an-acquirer--7N1oRTG8dGmOiIugC0cs4E) must allow transactions without the CVV code and two charging transactions in the same order. \r\n\r\nFor order changes with discounts, Order Management System (OMS) considers that you still can change the order's transactional value, as long as its status in Transaction Details is not `Finished`. \r\n\r\n## Order change and payment transaction flow \r\n\r\nAn order's [transaction flow](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/1xjzgJZvqwaI1rfxLMCC3Y) goes through various payment statuses before its conclusion. Within certain conditions, it is possible to change settled orders. The requirements are the following:\r\n\r\n- The order's [payment method](https://help.vtex.com/en/tutorial/difference-between-payment-methods-and-payment-conditions--3azJenhGFyUy2gsocms42Q) is a credit card.\r\n- The settlement occurs before the order is invoiced.\r\n- The payment connector is configured to allow partial refunds.\r\n\r\n> Currently, [Adyen](https://help.vtex.com/en/tutorial/configuring-payment-with-adyenv3--7xAz67E2Eg63LWCQNjVdwv) is the only payment connector that supports that operation.\r\n\r\nIf the order change increases or decreases the cost for the customer, the platform has the following behavior:\r\n\r\n- **Smaller price after order change:** An automatic notification is sent to the payment [gateway](https://help.vtex.com/tracks/payments--6GAS7ZzGAm7AGoEAwDbwJG/kdPbEIWf8Xq8tESQvViMB#gateway) to reimburse the customer for the difference.\r\n- **Higher price after order change:** An automatic notification is sent to the payment gateway to require the customer to pay for the additional cost.\r\n\r\n## Combining multiples operations\r\nYou can use this endpoint to make a single change operation or combine them in the same request. See some examples below.\r\n\r\n### Add request body example:\r\n\r\n```json\r\n{\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Remove request body example:\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to remove a product.\",\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 2,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n### Replace request body example:\r\n```json\r\n{\r\n \"reason\": \"The client wants to increase the product weight.\",\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n\r\n### Add, remove and replace request body example:\r\n\r\n\r\n```json\r\n{\r\n \"reason\": \"The client wants to add, remove and replace a weighable product.\",\r\n \"manualDiscountValue\": 0,\r\n \"add\": {\r\n \"items\": [\r\n {\r\n \"id\": \"8\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"remove\": {\r\n \"items\": [\r\n {\r\n \"id\": \"31\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"un\",\r\n \"unitMultiplier\": 1\r\n }\r\n ]\r\n },\r\n \"replace\": [\r\n {\r\n \"from\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1\r\n }\r\n ]\r\n },\r\n \"to\": {\r\n \"items\": [\r\n {\r\n \"id\": \"1\",\r\n \"quantity\": 1,\r\n \"measurementUnit\": \"kg\",\r\n \"unitMultiplier\": 1.0\r\n\ \ }\r\n ],\r\n \"shippingData\": {\r\n \"logisticsInfo\": [\r\n {\r\n \"itemIndex\": 0,\r\n \"slaId\": \"Normal\",\r\n \"deliveryChannel\": \"delivery\",\r\n \"addressId\": \"12334048475146857\",\r\n \"price\": 1000\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n ]\r\n}\r\n```\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." parameters: - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: changeOrderId in: path description: Order ID of the order you wish to change. required: true style: simple schema: type: string example: v12772213qst-02 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/Createchange' - example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 required: true responses: '202': description: Accepted content: application/json: schema: allOf: - $ref: '#/components/schemas/response202' example: requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: measurementUnit: unitMultiplier: 0 sellingPrice: name: detailUrl: imageUrl: shippingData: logisticsInfo: [] to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: productRefId: refId: ean: name: skuName: modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: productCategories: {} quantity: 1 seller: sellerChain: - imageUrl: detailUrl: components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: shipsTo: [] itemId: '1' deliveryChannels: [] price: 600 listPrice: 600 shippingEstimate: dockEstimate: shippingEstimateDate: lockTTL: deliveryCompany: polygonName: transitTime: sellingPrice: 600 deliveryIds: [] deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] get: tags: - Change Order (Beta) summary: VTex Get order change history operationId: GetChangeHistory description: "This endpoint retrieves a history of every successful [Change order request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single change request, you can use the endpoint [Get order change details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:/developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:/help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." parameters: - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: changeOrderId in: path description: Order ID of the order you wish to get the change history. required: true style: simple schema: type: string example: v12772213qst-02 responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/GetChangeHistory' - example: requests: - requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] actions: [] example: requests: - requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] actions: [] /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}: get: tags: - Change Order (Beta) summary: VTex Get order change details description: "This endpoint retrieves detailed information about a specific order change. So after creating multiple changes, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, with some additional fields:\r\n\r\n- `status`: The change request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `inProgress`: When set as `true`, the order is still progressing in the order flow, when set as `false`, it is complete, whether by cancellation or because the customer received it.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the changes made to an order, use the [Get order change history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." operationId: GetChangeDetail parameters: - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: changeOrderId in: path description: Order ID of the order you wish to get the change detail. required: true style: simple schema: type: string example: v12772213qst-02 - name: changeRequestId in: path description: Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. There are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history. required: true style: simple schema: type: string example: e8532a32-7f7e-434a-88ec-29609f0ede46 responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/GetChangeDetail' example: requests: - requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] actions: [] /api/order-system/orders/{changeOrderId}/changes/preview: post: tags: - Change Order (Beta) summary: VTex Preview order change operationId: PreviewChange description: "This endpoint allows you to simulate an order change and preview what the real change will look like if you use the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual change helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, and the response body of a successful request provides a preview of the change order effect.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." parameters: - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: changeOrderId in: path description: Order ID of the order you wish to preview change. required: true style: simple schema: type: string example: v12772213qst-02 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/PreviewChange' - example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 required: true responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/PreviewChange1' - example: reason: I would like to receive a preview. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 420 totals: - id: ManualValues name: Manual Values Total value: 0 - id: Shipping name: Shipping Total value: 420 add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 303A1E4534984FF295BA571BF08C8297 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T18:01:26.4743309Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] example: reason: I would like to receive a preview. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 420 totals: - id: ManualValues name: Manual Values Total value: 0 - id: Shipping name: Shipping Total value: 420 add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 303A1E4534984FF295BA571BF08C8297 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T18:01:26.4743309Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry: post: tags: - Change Order (Beta) summary: VTex Retry order change operationId: RetryChange description: "This endpoint makes a new attempt to perform an order change previously made using the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) request. When you retry to change an order using the `changeRequestId`, instead of creating a new change, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: changeOrderId in: path description: Order ID of the order you wish to retry change. required: true style: simple schema: type: string example: v12772213qst-02 - name: changeRequestId in: path description: "Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to changes you can perform using the same `changeRequestId`, and we recommend keeping all changes of a given order grouped by the same `changeRequestId`, so you will have a unified change history." required: true style: simple schema: type: string example: e8532a32-7f7e-434a-88ec-29609f0ede46 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/Createchange' - example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 required: true responses: '204': description: No Content content: {} /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel: post: tags: - Change Order (Beta) summary: VTex Cancel order change operationId: CancelChangeStoppedonError description: "This endpoint cancels an [order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a change was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once an order change has been successfully processed, canceling it is no longer possible. If you wish to revert the changes made to an order, you will have to [create a new order change](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Oms |

Cancel order

Change order

|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |

Cancel order

Change order

|\r\n| inStore Sales Person |

Cancel order

Change order

|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication)." parameters: - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: an in: query description: Name of the VTEX account that created the order. required: true style: form explode: true schema: type: string example: storeName - name: changeOrderId in: path description: Order ID of the order with the changes you wish to cancel. required: true style: simple schema: type: string example: v12772213qst-02 - name: changeRequestId in: path description: Once you make an order change, you generate a `requestId` code that identifies the changes made to that order. This field should be filled with that code. After cancelling an order change, the `changeRequestId` will no longer be valid. required: true style: simple schema: type: string example: e8532a32-7f7e-434a-88ec-29609f0ede46 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/CancelChangeStoppedonError' - example: reason: I want to cancel this change order request because it's stopped on a blocking error. example: reason: I want to cancel this change order request because it's stopped on a blocking error. required: true responses: '200': description: OK security: - appKey: - '{{appKey}}' appToken: - '{{appToken}}' components: parameters: UNUSED_incompleteOrders: name: incompleteOrders in: query description: You can use this parameter to filter [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders) by their situations, whether permanent (`perm`) or temporary (`temp`). When the situation is temporary, the order is still opened and has not being cancelled. To filter the total number of incomplete orders, use the value `all`. required: false style: form explode: true schema: type: string example: all securitySchemes: appKey: type: apiKey in: header name: X-VTEX-API-AppKey appToken: type: apiKey in: header name: X-VTEX-API-AppToken schemas: GetOrder: title: GetOrder required: - emailTracked - approvedBy - cancelledBy - cancelReason - orderId - sequence - marketplaceOrderId - marketplaceServicesEndpoint - sellerOrderId - origin - affiliateId - salesChannel - merchantName - status - statusDescription - value - creationDate - lastChange - orderGroup - totals - items - marketplaceItems - clientProfileData - giftRegistryData - marketingData - ratesAndBenefitsData - shippingData - paymentData - packageAttachment - sellers - callCenterOperatorData - followUpEmail - lastMessage - hostname - invoiceData - changesAttachment - openTextField - roundingError - orderFormId - commercialConditionData - isCompleted - customData - storePreferencesData - allowCancellation - allowEdition - isCheckedIn - marketplace - authorizedDate - invoicedDate type: object properties: emailTracked: type: string approvedBy: type: string nullable: true cancelledBy: type: string description: User that canceled the order. nullable: true cancelReason: type: string nullable: true description: Explanation for cancellation. orderId: type: string sequence: type: string marketplaceOrderId: type: string marketplaceServicesEndpoint: type: string sellerOrderId: type: string origin: type: string affiliateId: type: string salesChannel: type: string merchantName: type: string nullable: true status: type: string statusDescription: type: string description: '`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.' deprecated: true value: type: integer creationDate: type: string lastChange: type: string orderGroup: type: string nullable: true totals: type: array items: $ref: '#/components/schemas/Total' description: Array containing totals' information. items: type: array items: $ref: '#/components/schemas/Item' description: Array containing items' information. marketplaceItems: type: array items: type: string description: Array containing marketplace items information. clientProfileData: $ref: '#/components/schemas/ClientProfileData' giftRegistryData: type: string nullable: true marketingData: type: string nullable: true ratesAndBenefitsData: $ref: '#/components/schemas/RatesAndBenefitsData' shippingData: $ref: '#/components/schemas/ShippingData' paymentData: $ref: '#/components/schemas/PaymentData' packageAttachment: $ref: '#/components/schemas/PackageAttachment' sellers: type: array items: $ref: '#/components/schemas/Seller' description: Array containing sellers information. callCenterOperatorData: type: string nullable: true followUpEmail: type: string lastMessage: type: string nullable: true hostname: type: string invoiceData: type: object description: Information pertinent to the order's invoice. nullable: true changesAttachment: $ref: '#/components/schemas/ChangesAttachment' openTextField: type: string description: "This field must be filled in using the following format: \n\r```\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r```\n\r." nullable: true roundingError: type: integer orderFormId: type: string commercialConditionData: type: string nullable: true isCompleted: type: boolean customData: type: string nullable: true storePreferencesData: $ref: '#/components/schemas/StorePreferencesData' allowCancellation: type: boolean allowEdition: type: boolean isCheckedIn: type: boolean marketplace: $ref: '#/components/schemas/Marketplace' authorizedDate: type: string invoicedDate: type: string nullable: true example: emailTracked: a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br approvedBy: Person's name cancelledBy: Person's name cancelReason: Explanation for cancellation orderId: v5195004lux-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v5195004lux-01 origin: Marketplace affiliateId: '' salesChannel: '1' merchantName: status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: lockId: 00-v5195004lux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - ' 1 week' - ' 2 week' - ' 3 week' - ' 4 week' sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: parentItemIndex: parentAssemblyBinding: callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: giftRegistryData: marketingData: marketing data ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: geoCoordinates: [] logisticsInfo: - itemIndex: 1 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 - id: pickup-in-point stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: region46 pickupPointId: 1_VTEX-RJ transitTime: 3d trackingHints: selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: geoCoordinates: [] paymentData: transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} packageAttachment: packages: [] sellers: - id: '1' name: Loja do Suporte logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName callCenterOperatorData: followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: hostname: luxstore invoiceData: changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: isCompleted: true customData: storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: false allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: Total: title: Total required: - id - name - value type: object properties: id: type: string description: Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. name: type: string description: Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. value: type: integer description: Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. example: id: Items name: Total dos Itens value: 3290 Item: title: Item required: - uniqueId - id - productId - ean - lockId - itemAttachment - attachments - quantity - seller - name - refId - price - listPrice - manualPrice - priceTags - imageUrl - detailUrl - components - bundleItems - params - offerings - attachmentOfferings - sellerSku - priceValidUntil - commission - tax - preSaleDate - additionalInfo - measurementUnit - unitMultiplier - sellingPrice - isGift - shippingPrice - rewardValue - freightCommission - priceDefinitions - taxCode - parentItemIndex - parentAssemblyBinding - callCenterOperator - serialNumbers - assemblies - costPrice type: object properties: uniqueId: type: string description: Unique ID is an alphanumeric sequence that identifies an SKU in a given order. id: type: string description: Item's SKU ID, which is a unique numerical identifier. productId: type: string description: ID of the Product associated with the item. ean: type: string nullable: true description: EAN of the SKU. lockId: type: string description: Reservation ID. itemAttachment: $ref: '#/components/schemas/ItemAttachment' attachments: type: array items: type: string description: Array containing information on attachments. quantity: type: integer description: Quantity of items. seller: type: string description: Seller related to the order. name: type: string description: Item's name. refId: type: string description: Product referencial code associated with the item. price: type: integer description: Item's price. listPrice: type: integer description: Item's list price. manualPrice: type: string nullable: true description: Item's manual price. priceTags: type: array items: type: string description: List of objects with item's price modifiers. imageUrl: type: string description: Item's SKU image URL. detailUrl: type: string description: URL slug of the item. components: type: array items: type: string description: Item's components. bundleItems: type: array items: type: string description: Information on services sold along with the item's SKU. For example, a gift package. params: type: array items: type: string description: Information about params. offerings: type: array items: type: string description: Name of the service related to the item. For example, guarantee or installation. description: Item's offerings, which are services related to the item. For example, guarantee or installation. attachmentOfferings: type: array description: List of attachments details. nullable: true items: type: object required: - name - required - schema properties: name: type: string description: Name of the attachment. nullable: true required: type: boolean description: If the attachment is required (`true`) or not (`false`). nullable: true schema: type: object description: Schema of the content declared in the field `attachmentOfferings`. nullable: true sellerSku: type: string description: SKU ID from the seller perspective. priceValidUntil: type: string nullable: true description: Date until when the price is going to be valid if there is a promotion. commission: type: integer description: Commission value registered for the seller. tax: type: integer description: Item's tax. preSaleDate: type: string nullable: true description: Item's pre sale date. additionalInfo: $ref: '#/components/schemas/AdditionalInfo' measurementUnit: type: string description: Item's measurement unit. unitMultiplier: type: integer description: Item's unit multiplier. sellingPrice: type: integer description: Item's selling price. isGift: type: boolean description: This field is `true` when the item is a gift in order context and `false` when it is not. shippingPrice: type: string nullable: true description: Item's shipping price. rewardValue: type: integer description: Item's reward value. freightCommission: type: integer description: Value of the freight commission. priceDefinitions: type: object description: Item's price information. required: - sellingPrices - calculatedSellingPrice - total properties: sellingPrices: type: array items: required: - value - quantity properties: value: type: integer description: Total value of items in cents. quantity: type: integer description: Quantity of items. description: Details on item's selling price. calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value of all item's units in cents. taxCode: type: string nullable: true description: ' Item''s tax code.' parentItemIndex: type: string nullable: true description: Parent item index. parentAssemblyBinding: type: string nullable: true description: Parent assembly binding. callCenterOperator: type: string description: Call center operator responsible for the order. nullable: true serialNumbers: type: string description: This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control. deprecated: true nullable: true assemblies: type: array description: Retrieves information about orders item's customizations. nullable: true items: type: string costPrice: type: integer description: Item's cost price. example: uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: lockId: 00-v5195004lux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - ' 1 week' - ' 2 week' - ' 3 week' - ' 4 week' - name: vtex.subscription.daily required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 5 Domain: - 1 day sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: parentItemIndex: parentAssemblyBinding: callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 ItemAttachment: title: ItemAttachment description: Information about attachments, if it applies. required: - content - name type: object properties: content: type: object description: Attachment's custom field for content. name: type: string nullable: true description: Attachment's name. example: content: {} name: AdditionalInfo: title: AdditionalInfo description: Additional information about the item. required: - brandName - brandId - categoriesIds - productClusterId - commercialConditionId - dimension - offeringInfo - offeringType - offeringTypeId type: object properties: brandName: type: string description: Item's brand name. brandId: type: string description: Item's brand ID. categoriesIds: type: string description: Item's category ID. productClusterId: type: string description: All product clusters related to the item. commercialConditionId: type: string description: Commercial conditions ID. dimension: $ref: '#/components/schemas/Dimension' offeringInfo: type: string nullable: true description: 'Information about services related to the item. For example: guarantee or installation.' offeringType: type: string nullable: true description: Offering type. offeringTypeId: type: string nullable: true description: Offering type ID. example: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: Dimension: title: Dimension required: - cubicweight - height - length - weight - width type: object properties: cubicweight: type: number description: Item's cubic weight. height: type: integer description: Item's height. length: type: integer description: Item's length. weight: type: integer description: Item's weight. width: type: integer description: Item's width. example: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 ClientProfileData: title: ClientProfileData description: Object with information on the client's profile. required: - id - email - firstName - lastName - documentType - document - phone - corporateName - tradeName - corporateDocument - stateInscription - corporatePhone - isCorporate - userProfileId - customerClass type: object properties: id: type: string description: Object ID, the expected value is `clientProfileData`. email: type: string description: Customer's email. firstName: type: string description: Customer's first name. lastName: type: string description: Customer's last name. documentType: type: string description: Type of the document informed by the customer. document: type: string description: Document identification code informed by the customer. phone: type: string description: Customers's phone number. corporateName: type: string nullable: true description: If the customer is a legal entity, here goes the corporate name. tradeName: type: string nullable: true description: If the customer is a legal entity, here goes the trade name. corporateDocument: type: string nullable: true description: If the customer is a legal entity, here goes the corporate document. stateInscription: type: string nullable: true description: If the customer is a legal entity, here goes the state inscription. corporatePhone: type: string nullable: true description: If the customer is a legal entity, here goes the corpany's phone number. isCorporate: type: boolean description: The value is `true` when the customer is a legal entity and `false` when not. userProfileId: type: string description: Customer user profile ID. customerClass: type: string nullable: true description: Identification of the class the customer belongs to. example: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: RatesAndBenefitsData: title: RatesAndBenefitsData description: Information on promotions and taxes that apply to the order. required: - id - rateAndBenefitsIdentifiers type: object properties: id: type: string description: ID of the rate or benefit. rateAndBenefitsIdentifiers: type: array items: type: string description: Information about order's promotions and taxes identifiers. example: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] ShippingData: title: ShippingData description: Object containing shipping data. required: - id - address - logisticsInfo - trackingHints - selectedAddresses type: object properties: id: type: string description: Object ID, the expected value is `shippingData`. address: $ref: '#/components/schemas/Address' logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfo' description: Array of objects containing item's logistics information. trackingHints: type: string nullable: true selectedAddresses: type: array items: $ref: '#/components/schemas/SelectedAddress' description: Information about selected adresses. example: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store35 transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store45 transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store45 transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store46 transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '4791759472332' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: '' pickupPointId: store67 transitTime: 3d trackingHints: selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: geoCoordinates: [] Address: title: Address description: Shipping address details. required: - addressType - receiverName - addressId - versionId - entityId - postalCode - city - state - country - street - number - neighborhood - complement - reference - geoCoordinates type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`, among others. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Shipping address ID. versionId: type: string description: Shipping address version ID. nullable: true entityId: type: string description: Shipping address entity ID. nullable: true postalCode: type: string description: Postal code of the shipping address. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address when it applies. reference: type: string nullable: true description: Complement to help locate the shipping address, in case of delivery. geoCoordinates: type: array items: type: number description: Array with two numbers with geocoordinates, first longitude then latitude. example: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: geoCoordinates: [] LogisticsInfo: title: LogisticsInfo required: - itemIndex - selectedSla - lockTTL - price - listPrice - sellingPrice - deliveryWindow - deliveryCompany - shippingEstimate - shippingEstimateDate - slas - shipsTo - deliveryIds - deliveryChannels - deliveryChannel - pickupStoreInfo - addressId - versionId - entityId - polygonName - pickupPointId - transitTime type: object properties: itemIndex: type: integer description: Index of the item starting from 0. selectedSla: type: string description: Selected shipping option. lockTTL: type: string description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time. price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. listPrice: type: integer description: SKU's optional price for a specific trade policy. sellingPrice: type: integer description: Item's selling price. deliveryWindow: type: string nullable: true description: '[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item.' deliveryCompany: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.' shippingEstimate: type: string description: Total shipping estimate time in days. For instance, three business days is represented `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. It is defined only after the confirmation of the order. slas: type: array items: $ref: '#/components/schemas/Sla' description: Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140). shipsTo: type: array items: type: string description: Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryId' description: Information about delivery IDs. deliveryChannels: type: array description: List of delivery channels associated with the trade policy. items: type: object required: - id - stockBalance properties: id: type: string description: Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`. stockBalance: type: integer description: Stock check for an SKU availability. deliveryChannel: type: string description: If the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' addressId: type: string description: Address ID. versionId: type: string description: Shipping address version ID. nullable: true entityId: type: string description: Shipping address entity ID. polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. pickupPointId: type: string description: '[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)''s ID.' transitTime: type: string description: Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. example: itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: pickupPointId: 1_VTEX-RJ transitTime: 3d Sla: title: Sla required: - id - name - shippingEstimate - deliveryWindow - price - deliveryChannel - pickupStoreInfo - polygonName - lockTTL - pickupPointId - transitTime - pickupDistance type: object properties: id: type: string description: ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). name: type: string description: Name of the shipping policy. shippingEstimate: type: string description: Total shipping estimate time in days. For instance, three business days is represented `3bd`. deliveryWindow: type: string nullable: true description: '[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.' price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. deliveryChannel: type: string description: If the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. lockTTL: type: string description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. pickupPointId: type: string description: '[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.' transitTime: type: string description: Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. pickupDistance: type: number description: Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. example: id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 PickupStoreInfo: title: PickupStoreInfo description: Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). required: - additionalInfo - address - dockId - friendlyName - isPickupStore type: object properties: additionalInfo: type: string nullable: true description: Additional information about the pickup point. address: type: string nullable: true description: Pickup point's address. dockId: type: string nullable: true description: ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point. friendlyName: type: string nullable: true description: Name of the pickup point displayed at checkout. isPickupStore: type: boolean description: If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not. example: additionalInfo: address: dockId: friendlyName: isPickupStore: false DeliveryId: title: DeliveryId description: Information about delivery IDs. required: - courierId - courierName - dockId - quantity - warehouseId - accountCarrierName - kitItemDetails type: object properties: courierId: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)''s ID.' courierName: type: string description: Carrier's name. dockId: type: string description: ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj). quantity: type: integer description: Quantity of items. warehouseId: type: string description: ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). accountCarrierName: type: string description: Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE). kitItemDetails: type: array description: Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any. nullable: true items: type: string example: courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] SelectedAddress: title: SelectedAddress required: - addressId - versionId - entityId - addressType - receiverName - street - number - complement - neighborhood - postalCode - city - state - country - reference - geoCoordinates type: object properties: addressId: type: string description: Selected address ID. versionId: type: string description: Shipping address version ID of the selected address. nullable: true entityId: type: string description: Shipping address entity ID of the selected address. nullable: true addressType: type: string description: Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`. receiverName: type: string description: Name of the person who is going to receive the order in the selected address. street: type: string description: Street of the selected address. number: type: string description: Number of the building, house or apartment of the selected address. complement: type: string description: Complement to the selected address if it applies. neighborhood: type: string description: Neighborhood of the selected address. postalCode: type: string description: Postal code of the selected address. city: type: string description: City of the selected address. state: type: string description: State of the selected address. country: type: string description: Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3). reference: type: string nullable: true description: Complement to help locate the selected address. geoCoordinates: type: array items: type: number description: Array with two numbers with the selected address's geocoordinates, first longitude then latitude. example: addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: geoCoordinates: [] PaymentData: title: PaymentData description: Object with information about the payment. required: - transactions type: object properties: giftCards: type: array description: Array with information about Gift Cards. items: type: string transactions: type: array items: $ref: '#/components/schemas/Transaction' description: Information about financial transactions. example: giftCards: [] transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} Transaction: title: Transaction description: Financial transaction details. required: - isActive - transactionId - merchantName - payments type: object properties: isActive: type: boolean description: When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive. transactionId: type: string description: ID of the transaction. merchantName: type: string description: Name of the merchant that will receive the payment. payments: type: array items: $ref: '#/components/schemas/Payment' description: Detailed information about payment. example: isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} Payment: title: Payment description: Payment details. required: - id - paymentSystem - paymentSystemName - value - installments - referenceValue - cardHolder - cardNumber - firstDigits - lastDigits - cvv2 - expireMonth - expireYear - url - giftCardId - giftCardName - giftCardCaption - redemptionCode - group - tid - dueDate - connectorResponses - giftCardProvider - giftCardAsDiscount - koinUrl - accountId - parentAccountId - bankIssuedInvoiceIdentificationNumber - bankIssuedInvoiceIdentificationNumberFormatted - bankIssuedInvoiceBarCodeNumber - bankIssuedInvoiceBarCodeType - billingAddress type: object properties: id: type: string description: VTEX payment ID that can be used as unique identifier. paymentSystem: type: string description: Payment system's ID. paymentSystemName: type: string description: Payment system's name. value: type: integer description: Payment's final amount in cents. installments: type: integer description: Number of payment installments. referenceValue: type: integer description: Payment's reference value in cents. cardHolder: type: string nullable: true description: Name of the person who owns the card. cardNumber: type: string nullable: true description: Numeric sequence of the card used in the transaction. firstDigits: type: string nullable: true description: Fist digits of the card used in the transaction. lastDigits: type: string nullable: true description: Last digits of the card used in the transaction. cvv2: type: string nullable: true description: Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions. expireMonth: type: string nullable: true description: Expire month of the card used in the transaction (2-digits). expireYear: type: string nullable: true description: Expire year of the card used in the transaction (4-digits). url: type: string description: Payment's URL. giftCardId: type: string nullable: true description: Gift Card's ID. giftCardName: type: string nullable: true description: Gift Card's name. giftCardCaption: type: string nullable: true description: Gift Card's caption. redemptionCode: type: string nullable: true description: Code for the customer to use the Gift Card. group: type: string description: Name of the collection the Gift Card belongs to. tid: type: string nullable: true description: Provider's unique identifier for the transaction. dueDate: type: string description: Payment due date, with the format `yyyy-mm-dd`. connectorResponses: type: object description: Information about the connector responses. required: - Tid - ReturnCode - Message - authId properties: Tid: type: string description: Provider's unique identifier for the transaction. ReturnCode: type: string description: Provider's operation/error code to be logged. Message: type: string description: Provider's operation/error message to be logged. authId: type: string description: Connector's authorization ID. giftCardProvider: type: string description: Gift Card provider's ID. giftCardAsDiscount: type: boolean description: When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount. koinUrl: type: string description: Payment's account ID. accountId: type: string description: Payment's account ID. parentAccountId: type: string description: This field retrieves the main account if the payment was made in a subaccount. bankIssuedInvoiceIdentificationNumber: type: string description: Numeric sequence that identifies the bank issued invoice. bankIssuedInvoiceIdentificationNumberFormatted: type: string description: Bank issued invoice ID formatted. bankIssuedInvoiceBarCodeNumber: type: string description: Number of the bank issued invoice bar code. bankIssuedInvoiceBarCodeType: type: string description: Type of the bank issued invoice bar code. billingAddress: type: object description: Billing address information. example: id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} PackageAttachment: title: PackageAttachment description: Package object populated after order invoiced. required: - packages type: object properties: packages: type: array items: type: string description: Packages details. example: packages: [] Seller: title: Seller description: Information about the seller associated with the order. required: - id - name - logo - fulfillmentEndpoint type: object properties: id: type: string description: Seller ID that identifies the seller. name: type: string description: Seller's name. logo: type: string description: URL of the seller's logo. fulfillmentEndpoint: type: string description: URL of the endpoint for fulfillment of seller's orders. example: id: '1' name: Loja do Suporte logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName ChangesAttachment: title: ChangesAttachment description: Information about changes in the order. required: - id - changesData type: object properties: id: type: string description: Object ID, the expect value is `changeAttachment`. changesData: type: array items: $ref: '#/components/schemas/ChangesDatum' description: Order change details. example: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b ChangesDatum: title: ChangesDatum required: - reason - discountValue - incrementValue - itemsAdded - itemsRemoved - receipt type: object properties: reason: type: string description: Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails. discountValue: type: integer description: Order change discount value. incrementValue: type: integer description: Order change increment value. itemsAdded: type: array items: type: string description: List of items added to the order. itemsRemoved: type: array items: $ref: '#/components/schemas/ItemsRemoved' description: List of items removed from the order. receipt: $ref: '#/components/schemas/Receipt' example: reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b ItemsRemoved: title: ItemsRemoved required: - id - name - quantity - price - unitMultiplier type: object properties: id: type: string description: SKU ID of the item removed from the order. name: type: string description: Name of the item removed from the order. quantity: type: integer description: Quantity of items removed from the order. price: type: integer description: Total amount of items removed from the order. unitMultiplier: type: string nullable: true description: Unit multiplier of the item removed from the order. example: id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: Receipt: title: Receipt description: Information about the receipt for changed orders. required: - date - orderId - receipt type: object properties: date: type: string description: Date when the receipt was created. orderId: type: string description: ID of the order. receipt: type: string description: Receipt's unique identifier code. example: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b StorePreferencesData: title: StorePreferencesData description: Object with data from the store's configuration - stored in VTEX's License Manager. required: - countryCode - currencyCode - currencyFormatInfo - currencyLocale - currencySymbol - timeZone type: object properties: countryCode: type: string description: Three letters ISO code of the country (ISO 3166 ALPHA-3). currencyCode: type: string description: Currency code in ISO 4217. For example, `BRL`. currencyFormatInfo: $ref: '#/components/schemas/CurrencyFormatInfo' currencyLocale: type: integer description: Currency Locale Code in LCID in decimal. currencySymbol: type: string description: Currency symbol. timeZone: type: string description: Time zone from where the order was made. example: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time CurrencyFormatInfo: title: CurrencyFormatInfo description: Object with currency format details. required: - CurrencyDecimalDigits - CurrencyDecimalSeparator - CurrencyGroupSeparator - CurrencyGroupSize - StartsWithCurrencySymbol type: object properties: CurrencyDecimalDigits: type: integer description: Quantity of currency decimal digits. CurrencyDecimalSeparator: type: string description: Defines what currency decimal separator will be applied. CurrencyGroupSeparator: type: string description: Defines what currency group separator will be applied. CurrencyGroupSize: type: integer description: Defines how many characters will be grouped. StartsWithCurrencySymbol: type: boolean description: Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`). example: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true Marketplace: title: Marketplace description: Details about the marketplace related to the order. required: - baseURL - isCertified - name type: object properties: baseURL: type: string description: Marketplace base URL. isCertified: type: string nullable: true description: If is a certified marketplace. name: type: string description: Name of the marketplace. example: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore ListOrders: title: ListOrders required: - list - facets - paging - stats type: object properties: list: type: array items: $ref: '#/components/schemas/List' description: Array containing list information. facets: type: array items: type: string description: Array containing facets information. paging: $ref: '#/components/schemas/Paging' stats: $ref: '#/components/schemas/Stats' example: list: - orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502554' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide' ShippingEstimatedDate: '2019-01-31T12:36:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502551' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:40:55+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502548' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:35:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502544' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502541' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2018-12-19T18:22:26+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880102018018-01 sequence: '502537' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'cancelamento teste shp ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880091058221-01 sequence: '502535' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'Teste de cancelamento do ShopFácil ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 880090643370-01 sequence: '502534' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 876733475998-01 sequence: '502531' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL facets: [] paging: total: 84 pages: 6 currentPage: 1 perPage: 15 stats: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: List: title: List required: - orderId - creationDate - clientName - items - totalValue - paymentNames - status - statusDescription - marketPlaceOrderId - sequence - salesChannel - affiliateId - origin - workflowInErrorState - workflowInRetry - lastMessageUnread - ShippingEstimatedDate - ShippingEstimatedDateMax - ShippingEstimatedDateMin - orderIsComplete - listId - listType - authorizedDate - callCenterOperatorName - totalItems - currencyCode type: object properties: orderId: type: string creationDate: type: string clientName: type: string items: type: string nullable: true totalValue: type: integer paymentNames: type: string status: type: string statusDescription: type: string description: '`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.' marketPlaceOrderId: type: string nullable: true sequence: type: string salesChannel: type: string affiliateId: type: string origin: type: string workflowInErrorState: type: boolean workflowInRetry: type: boolean lastMessageUnread: type: string nullable: true ShippingEstimatedDate: type: string nullable: true ShippingEstimatedDateMax: type: string nullable: true ShippingEstimatedDateMin: type: string nullable: true orderIsComplete: type: boolean listId: type: string nullable: true listType: type: string nullable: true authorizedDate: type: string nullable: true callCenterOperatorName: type: string nullable: true totalItems: type: integer currencyCode: type: string example: orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL Paging: title: Paging required: - total - pages - currentPage - perPage type: object properties: total: type: integer pages: type: integer currentPage: type: integer perPage: type: integer example: total: 84 pages: 6 currentPage: 1 perPage: 15 Stats: title: Stats required: - stats type: object properties: stats: $ref: '#/components/schemas/Stats1' example: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Stats1: title: Stats1 required: - totalValue - totalItems type: object properties: totalValue: $ref: '#/components/schemas/TotalValue' totalItems: $ref: '#/components/schemas/TotalItems' example: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: TotalValue: title: TotalValue required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: $ref: '#/components/schemas/Facets' example: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: Facets: title: Facets required: - origin - currencyCode type: object properties: origin: $ref: '#/components/schemas/Origin' currencyCode: $ref: '#/components/schemas/CurrencyCode' example: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: Origin: title: Origin required: - Fulfillment - Marketplace type: object properties: Fulfillment: $ref: '#/components/schemas/Fulfillment' Marketplace: $ref: '#/components/schemas/Marketplace1' example: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: Fulfillment: title: Fulfillment required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace1: title: Marketplace1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: CurrencyCode: title: CurrencyCode required: - BRL type: object properties: BRL: $ref: '#/components/schemas/BRL' example: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: BRL: title: BRL required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: TotalItems: title: TotalItems required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: $ref: '#/components/schemas/Facets1' example: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Facets1: title: Facets1 required: - origin - currencyCode type: object properties: origin: $ref: '#/components/schemas/Origin1' currencyCode: $ref: '#/components/schemas/CurrencyCode1' example: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Origin1: title: Origin1 required: - Fulfillment - Marketplace type: object properties: Fulfillment: $ref: '#/components/schemas/Fulfillment1' Marketplace: $ref: '#/components/schemas/Marketplace2' example: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: Fulfillment1: title: Fulfillment1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: integer Min: type: integer Missing: type: integer StdDev: type: integer Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace2: title: Marketplace2 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: CurrencyCode1: title: CurrencyCode1 required: - BRL type: object properties: BRL: $ref: '#/components/schemas/BRL1' example: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: BRL1: title: BRL1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: number Min: type: integer Missing: type: integer StdDev: type: number Sum: type: integer SumOfSquares: type: integer Facets: type: string nullable: true example: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: RegisterChangeRequest: required: - requestId - reason - discountValue - incrementValue type: object properties: requestId: type: string description: Request identification of the change. Only the first change made with each `requestId` will be effective on a given order. Use different IDs for different changes to the same order. example: change-request-0123 reason: type: string description: Reason for order change. This may be shown to the shopper in the UI or transactional emails. example: Stock shortage discountValue: type: integer description: This field can be used to apply a discount to the total value of the order. Value in cents. example: 100 incrementValue: type: integer description: This field can be used to increment the total value of the order. Value in cents. example: 100 itemsRemoved: type: array description: List of items that should be removed from the order. items: type: object description: Removed items' details. required: - id - price - quantity properties: id: type: string description: Product ID of the item. example: '0' price: type: integer description: Price of the item in cents. example: 2499 quantity: type: integer description: Amount of items to be removed. example: 1 itemsAdded: type: array description: List of items that should be added to the order. items: type: object description: Added items' details. required: - id - price - quantity properties: id: type: string description: Product ID of the item. example: '0' price: type: integer description: Price of the item in cents. example: 2499 quantity: type: integer description: Amount of items to be added. example: 1 RegisterChange: type: object properties: date: type: string description: Date of order change. orderId: type: string description: ID of the order. receipt: type: string description: Receipt identification. AddLogRequest: title: AddLogRequest required: - source - message type: object properties: source: type: string message: type: string example: source: Postman message: Teste add interactions InvoiceNotificationRequest: title: InvoiceNotificationRequest required: - type - issuanceDate - invoiceNumber - invoiceValue - items type: object properties: type: type: string description: 'The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.' example: Output issuanceDate: type: string description: The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field. example: '2019-01-31T18:25:43-05:00' invoiceNumber: type: string description: Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code. example: DFG-v7731485plzv-01 nullable: true invoiceValue: type: string description: Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`. example: '2499' invoiceKey: type: string nullable: true description: Information about invoice Key. example: CFe35201100063960001504590006629690333214542150 invoiceUrl: type: string description: URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations. nullable: true example: https://luxstore.com/invoices/24382.pdf embeddedInvoice: type: string nullable: true description: XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre. example: "\r\n\r\n\r\n37\r\n000005177\r\nVenda a vista\r\n0\r\n55\r\n1\r\n1\r\n2018-07-06\r\n2018-07-06\r\n0\r\n79950308\r\n1\r\n1\r\n3\r\n2\r\n1\r\n0\r\nNF-eletronica.com\r\n\r\n\r\n99999090998760\r\nNF-e Associacao NF-e\r\nNF-e\r\n\r\nRua Central\r\n100\r\nFundos\r\nDistrito Industrial\r\n0000000\r\nMunicípio\r\nSP\r\n0000000\r\n1058\r\nBrasil\r\n1733021717\r\n\r\n123456789012\r\n\r\n\r\n00000000000000\r\nDISTRIBUIDORA DE AGUAS MINERAIS\r\n\r\nAV DAS FONTES\r\n1777\r\n1001 ANDAR\r\nPARQUE\r\n0000000\r\nSao Paulo\r\nSP\r\n00000000\r\n1058\r\nBRASIL\r\n3900000000\r\n\r\n \r\n\r\n\r\n000000000004\r\nAV PAULISTA\r\n12345\r\nTERREO\r\nCERQUEIRA CESAR\r\n0000000\r\nSAO PAULO\r\nSP\r\n\r\n\r\n00000000299000194\r\nAV FARIA LIMA\r\n154400\r\n156 ANDAR\r\nPINHEIROS\r\n0000308\r\nSAO PAULO\r\nSP\r\n\r\n\r\n\r\n00001\r\n\r\nAgua Mineral\r\n5101\r\ndz\r\n1000000.0000\r\n1\r\n10000000.00\r\n\r\nund\r\n12000000.0000\r\n1\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n00002\r\n\r\nAgua Mineral\r\n5101\r\npack\r\n5000000.0000\r\n2\r\n10000000.00\r\n\r\nund\r\n3000000.0000\r\n0.3333\r\n\r\n\r\n\r\n\r\n0\r\n00\r\n0\r\n10000000.00\r\n18.00\r\n1800000.00\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n0.65\r\n65000\r\n\r\n\r\n\r\n\r\n01\r\n10000000.00\r\n2.00\r\n200000.00\r\n\r\n\r\n\r\n\r\n\r\n\r\n20000000.00\r\n18.00\r\n0\r\n0\r\n20000000.00\r\n0\r\n0\r\n0\r\n0\r\n0\r\n130000.00\r\n400000.00\r\n0\r\n20000000.00\r\n\r\n\r\n\r\n0\r\n\r\n00000000000000\r\nDistribuidora de Bebidas Fazenda de SP Ltda.\r\n00000000999119\r\nRua Central 100 - Fundos - Distrito Industrial\r\nSAO PAULO\r\nSP\r\n\r\n\r\nBXI1717\r\nSP\r\n123456789\r\n\r\n\r\nUUU0000\r\nSP\r\n123456789\r\n\r\n\r\n10000\r\nCAIXA\r\nLINDOYA\r\n500\r\n1000000000.000\r\n1200000000.000\r\n\r\nXYZ10231486\r\n\r\n\r\n\r\n\r\nNota Fiscal de exemplo NF-eletronica.com\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nxFzhgdgnhjSD1e9uqe04lnoHT4ZzLSY=\r\n\r\n\r\n\r\nIz5Z3PLQbzZt9jnBtr6xsmHZMOu/3plXG9xxfFjRCQYGnD1rjlhzBGrqt026Ca2VHHM/bHNepi6FuFkAi595GScKVuHREUotzifE2OIjgavvTOrMwbXG7+0LYgkwPFiPCao2S33UpZe7MneaxcmKQGKQZw1fP8fsWmaQ4cczZT8=\r\n\r\n\r\n\r\n\r\nMIIEuzCCA6OgAwIBAgIDMTMxMA0GasfFSDAGQUAMIGSMQswCQYDVQQGEwJCUjELMAkGA1UECBMCUlMxFTATBgNVBAcTDFBvcnRvIEFsZWdyZTEdMBsGA1UEChMUVGVzdGUgUHJvamV0byBORmUgUlMxHTAbBgNVBAsTFFRlc3RlIFByb2pldG8gTkZlIFJTMSEwHwYDVQQDExhORmUgLSBBQyBJbnRlcm1lZGlhcmlhIDEwHhcNMDgwNDI4MDkwMTAyWhcNMDkwNDMwMjM1OTU5WjCBnjELMAkGA1UECBMCUlMxHTAfvw4567DRhg76FByb2pldG8gTkZlIFJTMR0wGwYDVQQKExRUZXN0ZSBQcm9qZXRvIE5GZSBSUzEVMBMGA1UEBxMMUE9SVE8gQUxFR1JFMQswCQYDVQQGEwJCUjEtMCsGA1UEAxMkTkZlIC0gQXNzb2NpYWNhbyBORi1lOjk5OTk5MDkwOTEwMjcwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDh6RRv0bj4RYX+tDQrZRb5opa77LBVVs+6LphIfSF3TSWPfnKh0+xLlBFdmnB5YGgbbW9Uon6pZQTfaC8jZhRhI5eFRRofY/Ugoeo0NGt6PcIQNZQd6lLQ/ASd1qWwjqJoEa7udriKjy3h351Mf1bng1VxS1urqC3Dn39ZWIEwQIDAQABo4IBjjCCAYowIgYDVR0jAQEABBgwFoAUPT5TqhNWAm+ZpcVsvB7malDBjEQwDwYDVR0TAQH/BAUwAwEBADAPBgNVHQ8BAf8EBQMDAOAAMAwGA1UdIAEBAAQCMAAwgbwGA1UdEQEBAASBsTCBrqA4BgVgTAEDBKAvBC0wNzA4MTk1MTE1MTk0NTMxMDg3MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDCgHQYFYEwBAwKgFAQSRmVybmFuZG8gQ2FudG8gQWx0oBkGBWBMAQMDoBAEDjk5OTk5MDkwOTEwMjcwoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEfZmVybmFuZG8tYWx0QHByb2NlcmdzLnJzLmdvdi5icjAgBgNVHSUBAf8EFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYDVR0fAQEABEkwRzBFoEOgQYY/aHR0cDovL25mZWNlcnRpZmljYWRvLnNlZmF6LnJzLmdvdi5ici9MQ1IvQUNJbnRlcm1lZGlhcmlhMzguY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCNPpaZ3Byu3/70nObXE8NiM53j1ddIFXsb+v2ghCVd4ffExv3hYc+/a3lfgV8H/WfQsdSCTzS2cHrd4Aasr/eXfclVDmf2hcWz+R7iysOHuT6B6r+DvV3JcMdJJCDdynR5REa+zViMnVZo1G3KuceQ7/y5X3WFNVq4kwHvonJ9oExsWyw8rTwUK5bsjz0A2yEwXkmkJIngnF41sP31+9jCImiqkXcmsesFhxzX7iurAQAQCZOm7iwMWxQKcAjXCZrgSZWRQy6mU224sX3HTArHahmLJ9Iw+WYAua5qBJsiN6PC7v5tfhdsgGD46DHMnOecxvkkPolDUyBa7d7xwgm\r\n\r\n\r\n\r\n\r\n" courier: type: string nullable: true description: The name of the carrier responsible for delivering the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*. example: carrierOne trackingNumber: type: string nullable: true description: The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*. example: '87658' trackingUrl: type: string nullable: true description: The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*. example: https://www.tracking.com/url dispatchedDate: type: string nullable: true description: Order dispatch date. May be `null`. example: '2019-02-08T13:16:13.4617653+00:00' items: type: array items: $ref: '#/components/schemas/Item1' description: Array containing the SKUs that are being invoiced. example: type: Output issuanceDate: 2019-01-302019-01-31T18:25:43-05:00 invoiceNumber: '9999' invoiceValue: '10000' invoiceKey: invoiceUrl: courier: trackingNumber: trackingUrl: dispatchedDate: '2019-01-31T18:25:43-05:00' items: - id: '1234' price: 10000 quantity: 1 Item1: title: Item1 required: - id - price - quantity type: object properties: id: type: string description: ID of the SKU being invoiced. price: type: integer description: Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity. example: 2499 description: type: string description: You can use this field for additional information about the SKU being invoiced. example: '335' quantity: type: integer description: Quantity currently in inventory of the SKU being invoiced. example: 2 example: id: '1234' price: 10000 description: '335' quantity: 1 Updatepartialinvoice.SendTrackingNumber.Request: title: Updatepartialinvoice.SendTrackingNumber.Request required: - trackingNumber - trackingUrl - courier - dispatchedDate type: object properties: trackingNumber: type: string description: The number code that identifies the order tracking. trackingUrl: type: string nullable: true description: Package tracking URL. dispatchedDate: type: string nullable: true description: Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00. courier: type: string nullable: true description: The name of the carrier responsible for delivering the order. example: trackingNumber: '87658' trackingUrl: https://www.tracking.com/url courier: carrierOne dispatchedDate: '2022-02-08T13:16:13.4617653+00:00' Updatepartialinvoice.SendTrackingNumber: title: Updatepartialinvoice.SendTrackingNumber required: - date - orderId - receipt type: object properties: date: type: string orderId: type: string receipt: type: string example: date: '2019-02-08T13:16:13.4617653+00:00' orderId: 00-v5195004lux-01 receipt: 527b1ae251264ef1b7a9b597cd8f16b9 UpdateTrackingStatusRequest: title: UpdateTrackingStatusRequest required: - isDelivered - deliveredDate - events type: object properties: isDelivered: type: boolean description: When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address. example: false deliveredDate: type: string nullable: true description: Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The `deliveredDate` format is `yyyy-mm-dd hh:mm`. example: 2022-10-01 21:15 events: type: array items: $ref: '#/components/schemas/Event' description: Array containing events information. example: isDelivered: false deliveredDate: events: - city: Rio de Janeiro state: RJ description: Coletado pela transportadora date: '2015-06-23' - city: Sao Paulo state: SP description: A caminho de Curitiba date: '2015-06-24' Event: title: Event required: - city - state - description - date type: object properties: city: type: string state: type: string description: type: string date: type: string example: city: Rio de Janeiro state: RJ description: Coletado pela transportadora date: '2015-06-23' UpdateTrackingStatus: title: UpdateTrackingStatus required: - date - orderId - receipt type: object properties: date: type: string orderId: type: string receipt: type: string example: date: '2017-03-29T18:04:31.0521233+00:00' orderId: v501245lspt-01 receipt: f67d33a8029c42ce9a8f07fc17f54449 GetConversation: title: GetConversation required: - id - from - to - subject - firstWords - body - hasAttachment - attachmentNames - date type: object properties: id: type: string description: Conversation ID. example: 2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3 from: $ref: '#/components/schemas/From' to: type: array items: $ref: '#/components/schemas/To' description: Conversation receiver. subject: type: string description: Conversation content subject. example: Your payment has been aproved. firstWords: type: string description: First words of Conversation content. example: Your payment has been aproved and we are waiting for... body: type: string description: Conversation content body. example: ' recorrenciaqa

Seu pagamento foi aprovado.

Referente ao Pedido #1305371685465-01

Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.

Pagamento

Visa final 1111
R$ 3,99 à vista

Atenciosamente,
Equipe recorrenciaqa

' hasAttachment: type: boolean description: When set as `true`, it means there are attachments, when set as `false`, there are not. example: false attachmentNames: type: array items: type: string description: Name of the attachment. example: attachments439505 description: List with attachments' names, if there are any. date: type: string description: Conversation date. example: '2023-01-23T09:23:31.0000000+00:00' example: id: 2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3 from: conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: noreply@vtexcommerce.com.br-9814872b.ct.store.com.br aliasMaskType: 0 email: noreply@store.com.br name: no reply role: 'null' to: - conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br aliasMaskType: 0 email: customer.name@email.com name: Mary John role: Customer subject: Your payment has been aproved. firstWords: Your payment has been aproved and we are waiting for... body: ' recorrenciaqa

Seu pagamento foi aprovado.

Referente ao Pedido #1305371685465-01

Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.

Pagamento

Visa final 1111
R$ 3,99 à vista

Atenciosamente,
Equipe recorrenciaqa

' hasAttachment: false attachmentNames: - attachments439505 date: '2023-01-23T09:23:31.0000000+00:00' From: title: From description: Conversation sender. required: - conversationRelatedTo - conversationSubject - emailAlias - aliasMaskType - email - name - role type: object properties: conversationRelatedTo: type: string description: Related order ID. example: 1305371685465-01 conversationSubject: type: string description: Conversation subject. example: oms emailAlias: type: string description: Sender transactional tracker email. example: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br aliasMaskType: type: integer description: Conversation tracker mask type. example: 0 email: type: string description: Sender's email. example: noreply@store.com.br name: type: string description: Sender's name. example: no reply role: type: string nullable: true description: If it is a client or null, for transactional emails. example: 'null' example: conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: noreply@vtexcommerce.com.br-9814872b.ct.store.com.br aliasMaskType: 0 email: noreply@store.com.br name: no reply role: 'null' To: title: To description: Conversation receiver. required: - conversationRelatedTo - conversationSubject - emailAlias - aliasMaskType - email - name - role type: object properties: conversationRelatedTo: type: string description: Related order ID. example: 1305371685465-01 conversationSubject: type: string description: Conversation subject. example: oms emailAlias: type: string description: Sender transactional tracker email. example: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br aliasMaskType: type: integer description: Conversation tracker mask type. example: 0 email: type: string description: Receiver's email. example: customer.name@email.com name: type: string description: Receiver's name. example: Mary John role: type: string description: If it is a customer or null, for transactional emails. example: Customer example: conversationRelatedTo: 1305371685465-01 conversationSubject: oms emailAlias: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br aliasMaskType: 0 email: customer.name@email.com name: Mary John role: Customer GetPaymenttransaction: title: GetPaymenttransaction required: - status - isActive - transactionId - merchantName - payments type: object properties: status: type: string description: Transaction status. isActive: type: boolean description: If it is an active transaction (`true`) or not (`false`). transactionId: type: string description: Transaction ID. merchantName: type: string description: Transaction merchant's name. payments: type: array items: $ref: '#/components/schemas/Payment1' description: Payments' details object. example: status: Finished isActive: true transactionId: CB452D77E7D04099A4DB0479087B1D2C merchantName: LUXSTORE payments: - id: 721CBE1090324D12ABE301FE33DE775A paymentSystem: '4' paymentSystemName: Mastercard value: 10150 installments: 1 referenceValue: 10150 cardHolder: cardNumber: firstDigits: '412341' lastDigits: '4123' cvv2: expireMonth: expireYear: url: giftCardId: giftCardName: giftCardCaption: redemptionCode: group: creditCard tid: '101770752' dueDate: connectorResponses: Tid: '101770752' ReturnCode: '200' Message: logMessage authId: '170852' Payment1: title: Payment1 required: - id - paymentSystem - paymentSystemName - value - installments - referenceValue - cardHolder - cardNumber - firstDigits - lastDigits - cvv2 - expireMonth - expireYear - url - giftCardId - giftCardName - giftCardCaption - redemptionCode - group - tid - dueDate - connectorResponses type: object properties: id: type: string description: Payment ID. paymentSystem: type: string description: Payment system ID. paymentSystemName: type: string description: Payment system name. value: type: integer description: Payment value. installments: type: integer description: Payment Installments quantity. referenceValue: type: integer description: Payment reference Value. cardHolder: type: string nullable: true description: Payment card holder. cardNumber: type: string nullable: true description: Payment card number. firstDigits: type: string description: Payment card first digits. lastDigits: type: string description: Payment card last digits. cvv2: type: string nullable: true description: Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions. expireMonth: type: string nullable: true description: Payment card expire month. expireYear: type: string nullable: true description: Payment card expire year. url: type: string nullable: true description: Payment URL. giftCardId: type: string nullable: true description: Gift Card ID. giftCardName: type: string nullable: true description: Gift Card name. giftCardCaption: type: string nullable: true description: Gift Card caption. redemptionCode: type: string nullable: true description: Code for the customer to use the Gift Card. group: type: string description: "It represents the payment method. For each method, it can have the following values: \n\r\n- **Credit card:** `creditCard` \r\n\r\n- **Debid card:** `debitCard`\r\n\r\n- **Bank invoice:** `bankInvoice`\r\n\r\n- **Promissory:** `promissory` \r\n\r\n- **Gift card:** `giftCard` \n\r\n- **Pix:** `instantPayment`." tid: type: string description: Payment transaction ID. dueDate: type: string nullable: true description: Payment due date. connectorResponses: $ref: '#/components/schemas/ConnectorResponses' example: id: 721CBE1090324D12ABE301FE33DE775A paymentSystem: '4' paymentSystemName: Mastercard value: 10150 installments: 1 referenceValue: 10150 cardHolder: cardNumber: firstDigits: '412341' lastDigits: '4123' cvv2: expireMonth: expireYear: url: giftCardId: giftCardName: giftCardCaption: redemptionCode: group: creditCard tid: '101770752' dueDate: connectorResponses: Tid: '101770752' ReturnCode: '200' Message: logMessage authId: '170852' ConnectorResponses: title: ConnectorResponses required: - Tid - ReturnCode - Message - authId type: object properties: Tid: type: string description: Connector transaction ID. ReturnCode: type: string nullable: true description: Connector return code. Message: type: string nullable: true description: Information about the connector's responses. authId: type: string description: Connector authorization ID. example: Tid: '101770752' ReturnCode: Message: authId: '170852' ConfirmitemfeedorderstatusRequest: title: ConfirmitemfeedorderstatusRequest required: - commitToken type: object properties: commitToken: type: string example: commitToken: Marketplace##{"Receipt":"+eXJYhj5rDqHa28+XUcfebDO4pve3TvMpPlW0ivc5STyE/40J6wxooXgBF8LZ9CdhZkFJnMYBVDwPwQtNEoZQrVtErDB2Yq2zs16QqsJuYxSrQtBfl9rMfmkO5orB9oDHSpvwL6DjDzcuJeQBBNxono/m4F6BloJEsk9BmuTmPaRI+7xsrN5Oeg8NPUoNSnsT983JPr1B+Y+TbbFjC1R8ZkvFHGVfti1QbhOwmYWTHPG08YMqla+Qwh7kUONLBXPqporF/CcqJo5YVTSu2uBcCuXkUo+OH9uUTn6hHkUROo=","PublisheId":"C0111A50CEB244E59C95422870127A4F","PublisheId_Item":"C0111A50CEB244E59C95422870127A4F","EventId":"0dc05b6b-48a5-4f03-975a-a69fb6550aaa","LastSendOverwrite":null} Getfeedorderstatus: title: Getfeedorderstatus required: - eventId - handle - domain - state - lastState - orderId - lastChange - currentChange type: object properties: eventId: type: string handle: type: string domain: type: string state: type: string lastState: type: string orderId: type: string lastChange: type: string currentChange: type: string example: eventId: ED423DDED4C1AE580CADAC1A4D02DA3F handle: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoidnRleGFwcGtleS1wYXJ0bmVyc2xhdGFtLVJNQkpNUyIsIkFwcEtleSI6InZ0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMiLCJBY2NvdW50IjoicGFydG5lcnNsYXRhbSIsIkhhbmRsZSI6IkFRRUIzbmtWR0piOXhhNGRjYlpkOTFVVWMyL2JObHc0Qnp3ZlNLV201Rjg2QXgrSGlRM053bEJkb2NwM2wvVytLdjFNQTZ4d3ZLcFYwYjlSeUttNVRpb3hrSVFMSG1Uck9xenB2aFlwU29uMzRrVmlNaWZHY2lnZFFqalBJdk00eWU4amVuaS9QKytaTmVxOFZWeFNGay81Yzg3YS84MTRjTFg2WGZPR2x2WitlTnVjTzA3S3UxK0xXaU5vQmJEY0cycGxKekxkRks3Qld3b1NTV3BmSWhrOGhmSFNkSzlzZVpJeG01QXFLbHFrUHNDNGk5emVaYVpBUVVrSi9aZWo3UjRrRDVRaXFjNmpjcnFheEdHc1lsNHMzUWM0ZmtWdmhYblJVQ2l2ZGdpMEtUYS8zcXlWWU9QTktIV2huTlZxMEZHNDNjME4vaWh6dDc0d1laNVl6aDFJRitHU2t1YTkrN1pCdnQ2VGs1cFRhZmVVclk0ckNPL2Fobnl1eXFLOG53ZkorVWxUTmt2ZVNFS29FdTNiUWQzSmc5R1lYWHlXOVVxRGo5dHJIZ1N5M3ZZa0dBWjd0MDZNZWUwQnBsdFBxWExaIiwiT3JkZXJJZCI6Ijk1MzcxMjAwNDEyNi0wMSIsIk1lc3NhZ2VJZCI6ImI5YjI4NDkwLTNjNzAtNDdjNi1hMTE3LWNhN2FjMTk2MDY1OSIsIkRvbWFpbiI6IkZ1bGZpbGxtZW50IiwiU3RhdGUiOiJyZWFkeS1mb3ItaGFuZGxpbmciLCJMYXN0U3RhdGUiOiJ3aW5kb3ctdG8tY2FuY2VsIiwiTGFzdENoYW5nZSI6IjA4LzEyLzIwMTkgMjA6NTQ6MDEiLCJDdXJyZW50Q2hhbmdlIjoiMDgvMTIvMjAxOSAyMDo1NDoyMyIsIkNyZWF0ZWRBdCI6IjA4LzEyLzIwMTkgMjE6MDE6MzAiLCJpc3MiOiJicm9hZGNhc3QtYXBpLnZ0ZXhjb21tZXJjZS5jb20uYnIiLCJhdWQiOiJwYXJ0bmVyc2xhdGFtX3Z0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMifQ.7RQBZQb6pHhFhA_jMKTiSoJbDck7awgD3Xx7sdJcW6w domain: Fulfillment state: ready-for-handling lastState: window-to-cancel orderId: 953712004126-01 lastChange: '2019-08-12T20:54:01.134057Z' currentChange: '2019-08-12T20:54:23.7153839Z' CommititemfeedorderstatusRequest: title: CommititemfeedorderstatusRequest required: - handles type: object properties: handles: type: array items: type: string description: List of item handles to commit. example: handles: - AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE= FeedConfigurationRequest: title: FeedConfigurationRequest required: - filter - queue type: object properties: filter: $ref: '#/components/schemas/FeedFilter' queue: $ref: '#/components/schemas/Queue' FeedFilter: title: Filter description: Object with type and status that will filter feed orders. required: - type type: object properties: type: type: string description: "Determines what orders appear in the feed and how they are filtered. There are two possible values:\n\r\n\r-`FromWorkflow`: the feed will receive order updates only when order’s statuses change and orders can be filtered by status, using the `status` field described below.\n\r\n\r-`FromOrders`: the feed gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions passed in the `expression` field described below." example: FromWorkflow status: type: array items: type: string description: "List of order statuses that should be included in the feed. This should only be used in case `type` is set to `FromWorkflow`. The status event will be removed, if it can't deliver a message more than 100 times, 4 days progressively. \r\n\r\n**Status available to filter** \r\n\r\n- order-created \n\r\n- on-order-completed \n\r\n- on-order-completed-ffm \n\r\n- payment-pending \n\r\n- waiting-for-order-authorization \n\r\n- approve-payment \n\r\n- payment-approved \n\r\n- request-cancel \n\r\n- waiting-for-seller-decision \n\r\n- waiting-ffmt-authorization \n\r\n- waiting-for-authorization \n\r\n- waiting-for-manual-authorization \n\r\n- authorize-fulfillment \n\r\n- order-create-error \n\r\n- order-creation-error \n\r\n- window-to-cancel \n\r\n- window-to-change-seller \n\r\n- waiting-for-mkt-authorization \n\r\n- waiting-seller-handling \n\r\n- ready-for-handling \n\r\n- start-handling \n\r\n- handling \n\r\n- invoice-after-cancellation-deny \n\r\n- order-accepted \n\r\n- invoice \n\r\n- invoiced \n\r\n- replaced \n\r\n- cancellation-requested \n\r\n- cancel \n\r\n- canceled." expression: type: string description: JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is set to `FromOrders`. disableSingleFire: type: boolean description: Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once. example: false HookFilter: title: Filter required: - type type: object properties: type: type: string description: "Determines what orders appear in the hook and how they are filtered. As shown in the examples above, there are two ways:\r\n\r\n - `FromWorkflow`: the hook will receive order updates only when there is a change or update in the [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). You must send at least one value for the `status` field to determine by which status the orders will be filtered.\r\n\r\n - `FromOrders`: the hook will receive order updates when there is a change in the order. In this case, orders can be filtered by any property, according to JSONata expressions passed in the `expression` field. You must send the request with values for the `expression` and `disableSingleFire` fields." example: FromWorkflow status: type: array items: type: string description: List of order statuses that should be included in the hook. This should only be used in case `type` is `FromWorkflow`. expression: type: string description: JSONata query expression that defines what conditions must be met for an order to be included in the hook. This should only be used in case `type` is `FromOrders`. disableSingleFire: type: boolean description: Sets a limit to how many times a specific order shows on the hook, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the hook only once. Send this field if you want to filter `FromOrders`. example: false Queue: title: Queue description: Object with information about timeout and message retention. required: - visibilityTimeoutInSeconds - MessageRetentionPeriodInSeconds type: object properties: visibilityTimeoutInSeconds: type: integer description: Period of time for which an item becomes invisible after it has been [retrieved](https://developers.vtex.com/vtex-rest-api/reference/feed-v3#getfeedorderstatus1). Measured in seconds. example: 250 MessageRetentionPeriodInSeconds: type: integer description: Maximum life span of an order update in the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds. example: 3456000 HookConfigurationRequest: title: HookConfigurationRequest required: - filter - hook type: object properties: filter: $ref: '#/components/schemas/HookFilter' hook: $ref: '#/components/schemas/Hook' example: filter: type: FromWorkflow status: - order-completed - handling - ready-for-handling - waiting-ffmt-authorization - cancel hook: url: https://endpoint.example/path headers: key: value Hook: title: Hook required: - url - headers type: object properties: url: type: string headers: $ref: '#/components/schemas/Headers' example: url: https://endpoint.example/path headers: key: value Headers: title: Headers required: - key type: object properties: key: type: string example: key: value HookConfiguration: title: HookConfiguration required: - Domain - OrderId - State - LastState - LastChange - CurrentChange - Origin type: object properties: Domain: type: string OrderId: type: string State: type: string LastState: type: string LastChange: type: string CurrentChange: type: string Origin: $ref: '#/components/schemas/Origin2' example: Domain: Fulfillment OrderId: v52277740atmc-01 State: ready-for-handling LastState: window-to-cancel LastChange: '2019-08-14T17:11:39.2550122Z' CurrentChange: '2019-08-14T17:12:48.0965893Z' Origin: Account: automacaoqa Key: vtexappkey-appvtex Origin2: title: Origin2 required: - Account - Key type: object properties: Account: type: string Key: type: string example: Account: automacaoqa Key: vtexappkey-appvtex Userorderslist: title: Userorderslist required: - list - facets - paging - stats type: object description: Order list object. properties: list: type: array items: $ref: '#/components/schemas/List1' description: List with user's orders details. facets: type: array items: type: string description: Array containing facets information. paging: $ref: '#/components/schemas/Paging' stats: $ref: '#/components/schemas/Stats2' example: list: - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502449llux-02 creationDate: '2018-08-28T17:42:40+00:00' clientName: Cunha VTEX items: totalValue: 118588 paymentNames: Promissory status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502452' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502449llux-02 Resumo Itens R$ 1.178,98 Entrega R$ 6,90 Total R$ 1.185,88' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 12 currencyCode: BRL - orderId: v502449llux-01 creationDate: '2018-08-28T17:42:28.9171556+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Mangueira Filtro ean: refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 21526180 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '502449' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v502058llux-01 creationDate: '2017-07-25T23:17:36.7963248+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Aquecedor Britania 1500 Branco ean: '1235567890143' refId: branquinho id: '1234568212' productId: '1000200' sellingPrice: 35599 price: 35599 totalValue: 35599 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '502058' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2017-07-29T19:24:20.7444363+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v501538llux-01 creationDate: '2017-06-26T16:57:58.9986524+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Boneco do Mário ean: bonecomario refId: bonecomario id: '1234568183' productId: '1000257' sellingPrice: 150363 price: 150363 - seller: '1' quantity: 1 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 151262 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '501538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2017-06-27T13:59:49.7705236+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v501020llux-01 creationDate: '2016-11-21T19:57:54.0415289+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 2 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 3190 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '501020' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-12-02T08:00:00+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500973llux-01 creationDate: '2016-10-10T17:19:30.8562035+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1" 4G CÂMERA 12 MP ean: refId: testefnac id: '1234568028' productId: '1000203' sellingPrice: 299000 price: 299000 totalValue: 299900 paymentNames: status: handling statusDescription: Preparando Entrega marketPlaceOrderId: '' sequence: '500973' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-10-10T14:23:17.1897068+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500970llux-01 creationDate: '2016-10-10T17:07:59.0889392+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Camiseta GG ean: refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 1799 paymentNames: status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '500970' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2016-10-10T14:13:34.4927265+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500890llux-01 creationDate: '2016-08-17T18:35:04.8659804+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M ean: absolutm refId: id: '549' productId: '9' sellingPrice: 1000 price: 1000 totalValue: 1000 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500890' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: - orderId: v500838llux-01 creationDate: '2016-07-29T00:20:47.7736718+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Rooibos Lavanda - Pouch - 50gr ean: '198' refId: '10098' id: '98' productId: '1000025' sellingPrice: 5200 price: 5200 totalValue: 6200 paymentNames: status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500838' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 0 currencyCode: facets: [] paging: total: 19 pages: 10 currentPage: 1 perPage: 2 stats: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} List1: title: List1 required: - orderId - creationDate - clientName - items - totalValue - paymentNames - status - statusDescription - marketPlaceOrderId - sequence - salesChannel - affiliateId - origin - workflowInErrorState - workflowInRetry - lastMessageUnread - ShippingEstimatedDate - ShippingEstimatedDateMax - ShippingEstimatedDateMin - orderIsComplete - listId - listType - authorizedDate - callCenterOperatorName - totalItems - currencyCode type: object properties: orderId: type: string description: Order ID is a unique code that identifies an order. creationDate: type: string description: Order's creation date. clientName: type: string description: Order's customer name. items: type: array items: $ref: '#/components/schemas/Item2' description: Information about order's items. nullable: true deprecated: true totalValue: type: integer description: Total value amount. paymentNames: type: string nullable: true description: Payment system name. status: type: string description: Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). statusDescription: type: string description: Status description which is displayed on the Admin panel. This field is deprecated and may not return any value. deprecated: true marketPlaceOrderId: type: string nullable: true description: Marketplace order ID. sequence: type: string description: Six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. salesChannel: type: string description: Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. affiliateId: type: string description: Corresponds to the three-digits [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order. origin: type: string description: Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. workflowInErrorState: type: boolean description: If there is a work flow error (`true`) or not (`false`). workflowInRetry: type: boolean description: If the order is in a work flow retry (`true`) or not (`false`). lastMessageUnread: type: string nullable: true description: Last sent transactional message. ShippingEstimatedDate: type: string nullable: true description: Estimate shipping date. ShippingEstimatedDateMax: type: string nullable: true description: The most extended shipping estimation possible. ShippingEstimatedDateMin: type: string nullable: true description: The least extended shipping estimation possible. orderIsComplete: type: boolean description: If it is a completed order (`true`) or not (`false`). For more information, see [Order flow and status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). listId: type: string nullable: true description: Related Gift List ID. listType: type: string nullable: true description: Related Gift list type. authorizedDate: type: string nullable: true description: Authorized order date. callCenterOperatorName: type: string nullable: true description: Call center operator responsible for the order. totalItems: type: integer description: Order's total amount of items. currencyCode: type: string nullable: true description: Currency code in ISO 4217. For example, `BRL`. example: orderId: 1172452900788-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Reservoir hose ean: refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Reservoir filter ean: refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparing for delivery marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: GTB origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL Item2: title: Item2 required: - seller - quantity - description - ean - refId - id - productId - sellingPrice - price type: object properties: seller: type: string description: Seller related to the order. quantity: type: integer description: Quantity of SKUs. description: type: string description: Description of items. ean: type: string nullable: true description: EAN of the SKU. refId: type: string nullable: true description: Item's reference ID. id: type: string description: Item's SKU ID, which is a unique numerical identifier. productId: type: string description: ID of the Product associated with the item. sellingPrice: type: integer description: Details on item's selling price. price: type: integer description: Item's price. example: seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 Stats2: title: Stats2 required: - stats type: object properties: stats: $ref: '#/components/schemas/Stats3' example: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} Stats3: title: Stats3 required: - totalValue - totalItems type: object properties: totalValue: $ref: '#/components/schemas/TotalValue1' totalItems: $ref: '#/components/schemas/TotalItems1' example: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} TotalValue1: title: TotalValue1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: integer Min: type: integer Missing: type: integer StdDev: type: integer Sum: type: integer SumOfSquares: type: integer Facets: type: object example: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} TotalItems1: title: TotalItems1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: integer Min: type: integer Missing: type: integer StdDev: type: integer Sum: type: integer SumOfSquares: type: integer Facets: type: object example: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} Userorderdetails: title: Userorderdetails required: - orderId - sequence - marketplaceOrderId - marketplaceServicesEndpoint - sellerOrderId - origin - affiliateId - salesChannel - merchantName - status - statusDescription - value - creationDate - lastChange - orderGroup - totals - items - marketplaceItems - clientProfileData - giftRegistryData - marketingData - ratesAndBenefitsData - shippingData - paymentData - packageAttachment - sellers - callCenterOperatorData - followUpEmail - lastMessage - hostname - invoiceData - changesAttachment - openTextField - roundingError - orderFormId - commercialConditionData - isCompleted - customData - storePreferencesData - allowCancellation - allowEdition - isCheckedIn - marketplace - authorizedDate - invoicedDate - cancelReason - itemMetadata - subscriptionData - taxData - checkedInPickupPointId - cancellationData - clientPreferencesData type: object properties: orderId: type: string description: Order ID is a unique code that identifies an order. sequence: type: string description: Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. marketplaceOrderId: type: string description: Marketplace order ID. marketplaceServicesEndpoint: type: string description: Marketplace services endpoint. sellerOrderId: type: string description: ID of the seller related to the order. It can be a VTEX seller or an external seller. origin: type: string description: Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. affiliateId: type: string description: Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order. salesChannel: type: string description: Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. merchantName: type: string description: Name of the merchant. status: type: string description: Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). statusDescription: type: string description: '`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.' deprecated: true value: type: integer description: Order's total amount. creationDate: type: string description: Order's creation date. lastChange: type: string description: Order's last change date. orderGroup: type: string description: Order's group ID. totals: type: array items: $ref: '#/components/schemas/Total' description: List with details about orders' totals. items: type: array items: $ref: '#/components/schemas/Item' description: Information about order's items. marketplaceItems: type: array items: type: string description: Marketplace details object. clientProfileData: $ref: '#/components/schemas/ClientProfileData' giftRegistryData: type: string nullable: true description: Information about gift list, when it applies. marketingData: type: object description: Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs. required: - id - utmSource - utmPartner - utmMedium - utmCampaign - coupon - utmiCampaign - utmipage - utmiPart - marketingTags properties: id: type: string description: Object ID which expected value is `marketingData`. utmSource: type: string description: Value of the `utm_source` parameter of the URL that led to the request. utmPartner: type: string description: UTM Source Parameters. utmMedium: type: string description: Value of the `utm_medium` parameter of the URL that led to the request. utmCampaign: type: string description: Value of the `utm_campaign` parameter of the URL that led to the request. coupon: type: string description: Coupon's code information. utmiCampaign: type: string description: Internal UTM value `utmi_cp`. utmipage: type: string description: Internal UTM value `utmi_p`. utmiPart: type: string description: Internal UTM value `utmi_pc`. marketingTags: type: array description: Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions. items: type: string ratesAndBenefitsData: $ref: '#/components/schemas/RatesAndBenefitsData' shippingData: $ref: '#/components/schemas/ShippingData' paymentData: $ref: '#/components/schemas/PaymentData' packageAttachment: $ref: '#/components/schemas/PackageAttachment' sellers: type: array items: $ref: '#/components/schemas/Seller' description: List of all sellers associated with the order. callCenterOperatorData: type: string nullable: true description: Call center operator responsible for the order. followUpEmail: type: string description: Email of the store's employee responsible for managing the order. lastMessage: type: string nullable: true description: Last sent transactional message. hostname: type: string description: Account Hostname registered in License Manager. invoiceData: type: object description: Information pertinent to the order's invoice. nullable: true changesAttachment: $ref: '#/components/schemas/ChangesAttachment' openTextField: type: string description: "Optional field with order's additional information. This field must be filled in using the following format: \n\r```\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r```\n\r." nullable: true roundingError: type: integer description: Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field. orderFormId: type: string description: '[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID.' commercialConditionData: type: string nullable: true description: Information about commercial conditions. isCompleted: type: boolean description: When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet. customData: type: string nullable: true description: Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt. storePreferencesData: $ref: '#/components/schemas/StorePreferencesData' allowCancellation: type: boolean description: When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order. allowEdition: type: boolean description: When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order. isCheckedIn: type: boolean description: This field is set `true` when the order was made via inStore and `false` when it was not. marketplace: $ref: '#/components/schemas/Marketplace' authorizedDate: type: string description: Authorized order date. invoicedDate: type: string nullable: true description: Order's invoice date. cancelReason: type: string description: Reason for order cancellation. nullable: true itemMetadata: type: object description: Metadata information about the order's items. required: - Items properties: Items: type: array description: Metadata items. items: type: object required: - Id - Seller - Name - SkuName - ProductId - RefId - Ean - ImageUrl - DetailUrl - AssemblyOptions properties: Id: type: string description: Item's SKU ID, which is a unique numerical identifier. Seller: type: string description: Seller ID that identifies the seller the item belongs to. Name: type: string description: Name of the item as displayed to customers in the storefront. SkuName: type: string description: Name of the SKU corresponding to the item. ProductId: type: string description: ID of the Product associated with the item. RefId: type: string description: Item's reference ID. Ean: type: string description: EAN of the item. ImageUrl: type: string description: Item's SKU image URL. DetailUrl: type: string description: URL slug of the item. AssemblyOptions: type: array description: Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any. items: required: - Id - Name - Required - InputValues - Composition type: object properties: Id: type: string description: ID of the attachment related to the order. Name: type: string description: Name of the attachment related to the order. Required: type: boolean description: If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional. InputValues: type: object description: Displays the attachment's content. nullable: true Composition: type: object description: Displays the attachment's composition. nullable: true subscriptionData: type: object description: Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453). nullable: true required: - SubscriptionGroupId - Subscriptions properties: SubscriptionGroupId: type: string description: ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions. Subscriptions: type: array description: List with subscriptions and their details. nullable: true items: type: object required: - ExecutionCount - PriceAtSubscriptionDate - ItemIndex - Plan properties: ExecutionCount: type: integer description: Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on. PriceAtSubscriptionDate: type: number description: Price of the order when the customer signed up for subscriptions. Subscriptions created from Admin UI or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3. deprecated: true ItemIndex: type: integer description: Each item in the subscriptions' order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on. Plan: type: object description: Information about the subscription's validility and frequency. required: - type - frequency - validity properties: type: type: string description: Type of plan. frequency: type: object description: Information about subscriptions' recurrence. required: - periodicity - interval properties: periodicity: type: string description: Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`. interval: type: integer description: Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on. validity: type: object description: Information about the period during which the subscription will be valid. required: - begin - end properties: begin: type: string description: Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`. end: type: string description: Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`. taxData: type: object description: Order's tax information. required: - areTaxesDesignatedByMarketplace - taxInfoCollection properties: areTaxesDesignatedByMarketplace: type: boolean description: If the taxes were designated by the marketplace (`true`) or not (`false`). taxInfoCollection: type: array description: Array with taxes' details. items: type: object required: - itemIndex - sku - priceTags properties: itemIndex: type: integer description: Item's indexing number. sku: type: string description: Alphanumeric sequence that identifies an SKU. priceTags: type: array description: Price tag information. items: type: object required: - isPercentual - name - rawValue properties: isPercentual: type: boolean description: If the tax is a percentage (`true`) or note (`false`). name: type: string description: Name that identifies the tax. rawValue: type: string description: The amount that corresponds to the tax. checkedInPickupPointId: type: string description: If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made. cancellationData: type: object description: Information about order cancellation, when it applies. required: - RequestedByUser - RequestedBySystem - RequestedBySellerNotification - RequestedByPaymentNotification - Reason - CancellationDate properties: RequestedByUser: type: boolean description: If the order cancellation was requested by the costumer (`true`) or not (`false`). RequestedBySystem: type: boolean description: If the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example. RequestedBySellerNotification: type: boolean description: If the order cancellation was requested by the seller (`true`) or not (`false`). RequestedByPaymentNotification: type: boolean description: If the order cancellation was requested by the payment gateway (`true`) or not (`false`). Reason: type: string description: The reason why the order was cancelled. CancellationDate: type: string description: The date when the order was cancelled. clientPreferencesData: type: object description: Information about customer's preferences. required: - locale - optinNewsLetter properties: locale: type: string description: Customer's prefered language while accessing the store. optinNewsLetter: type: boolean description: When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not. example: orderId: v502556llux-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v502556llux-01 origin: Marketplace affiliateId: '' salesChannel: '1' merchantName: luxstore status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: v502556lspt totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: lockId: 00-v502556llux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - ' 1 week' - ' 2 week' - ' 3 week' - ' 4 week' sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: parentItemIndex: parentAssemblyBinding: callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: Cunha documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: giftRegistryData: marketingData: id: marketingData utmSource: fb utmPartner: utm partner utmMedium: utm medium utmCampaign: christmas coupon: sale utmiCampaign: ' ' utmipage: ' ' utmiPart: ' ' marketingTags: - vtex-subscription ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '518' neighborhood: Botafogo complement: '10' reference: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: region56 pickupPointId: 1_VTEX-RJ transitTime: 3d trackingHints: selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: geoCoordinates: [] paymentData: transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} packageAttachment: packages: [] sellers: - id: '1' name: Lux Store logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName callCenterOperatorData: followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: hostname: luxstore invoiceData: changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v502556llux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: isCompleted: true customData: storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: true allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: cancelReason: The size was too big. itemMetadata: Items: - Id: '18' Seller: '1' Name: Cat food SkuName: Cat food ProductId: '6' RefId: '105' Ean: '43673557' ImageUrl: http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000 DetailUrl: /catfood/p AssemblyOptions: - Id: vtex.subscription.plan-ana Name: vtex.subscription.plan-ana Required: false InputValues: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 8 Domain: - 4 month - 1 month Composition: {} subscriptionData: SubscriptionGroupId: A64AC73C0FB8693A7ADB4AC69CA4FD5F Subscriptions: - ExecutionCount: 724 PriceAtSubscriptionDate: 100 ItemIndex: 0 Plan: type: RECURRING_PAYMENT frequency: periodicity: DAILY interval: 1 validity: begin: '2022-01-10T00:00:00.0000000+00:00' end: '2024-02-03T00:00:00.0000000+00:00' taxData: areTaxesDesignatedByMarketplace: true taxInfoCollection: - itemIndex: 0 sku: COLOCAR_O_SKUID priceTags: - isPercentual: false name: Taxes (Magazine Luisa) rawValue: COLOCAR_O_VALOR_SEM_DECIMAL checkedInPickupPointId: storeNameExample_901 cancellationData: RequestedByUser: true RequestedBySystem: false RequestedBySellerNotification: false RequestedByPaymentNotification: false Reason: Item was too big in the client. CancellationDate: 2022-10--05T15:40:33 clientPreferencesData: locale: en-US optinNewsLetter: false TestJSONataExpression: type: object required: - Expression - Document properties: Expression: type: string description: JSONata expression to be tested. Document: type: string description: JSON document to be evaluated by the expression. Createchange: title: Createchange required: - reason type: object properties: reason: type: string description: Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). example: The client wants to change a weighable product. replace: type: array items: $ref: '#/components/schemas/Replace' description: "Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r\n\r\n- `add`: the schema will correspond to the object `to` inside the `replace` array.\r\n\r\n- `remove`: the schema will correspond to the object `from` inside the `replace` array.\r\n\r\nYou will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same request." example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 Replace: title: Replace required: - from - to type: object properties: from: $ref: '#/components/schemas/FromV2' to: $ref: '#/components/schemas/ToV2' example: from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 FromV2: title: FromV2 required: - items type: object properties: items: type: array items: $ref: '#/components/schemas/ItemV2' description: Array with information about the item to be replaced. description: Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. For a complete example, see the description at the top of the page. example: items: - id: '1' quantity: 1 ItemV2: title: ItemV2 required: - id - quantity type: object properties: id: type: string description: SKU ID of the item that will be changed. example: '1' quantity: type: integer description: Quantity of the item been changed. example: 1 example: id: '1' quantity: 1 ToV2: title: ToV2 required: - items type: object properties: items: type: array items: $ref: '#/components/schemas/Item1V2' description: Array with information about the replacing item. shippingData: $ref: '#/components/schemas/ShippingDataV2' description: Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page. example: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 Item1V2: title: Item1V2 required: - id - quantity - measurementUnit - unitMultiplier type: object properties: id: type: string description: SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`. example: '1' quantity: type: integer description: Updated quantity of the item been changed. example: 1 measurementUnit: type: string description: Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a value, the request gets the information from the Catalog. example: kg unitMultiplier: type: number description: Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`. example: 3 example: id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 ShippingDataV2: title: ShippingDataV2 required: - logisticsInfo type: object properties: logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfoV2' description: Array containing information about the shipping address of the changed order. This field is optional, when you don't send it the request body, the system assumes there were no changes in shipping. example: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 LogisticsInfoV2: title: LogisticsInfoV2 required: - itemIndex - slaId - deliveryChannel - addressId - price type: object properties: itemIndex: type: integer description: Index that identifies the position of this item in the original array, starting from `0`. example: 0 slaId: type: string description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order. example: Normal deliveryChannel: type: string description: Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery. example: delivery addressId: type: string description: Shipping address ID. example: 9ec276fd3a604eb1aa151b5333ca5db7 price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. example: 1000 example: itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 response202: title: response202 required: - requestId - workflowId - reason - manualDiscountValue - manualIncrementValue - totalChangeValue - totals - add - remove - replace - date - origin - settings type: object properties: requestId: type: string description: Unique code that identifies a change order request. example: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: type: string description: Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). example: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: type: string description: Reason that motivated the order change. example: The client wants to change the items weight. manualDiscountValue: type: integer description: This field shows if a manual price was applied to the total order amount. The value is in cents. example: 0 manualIncrementValue: type: integer description: This field shows if an increment value was applied to the total order amount. The value is in cents. example: 0 totalChangeValue: type: integer description: This field shows how much the order total price is considering that price changes might have been made. The value is in cents. example: 0 totals: type: array items: type: string description: Array containing information about change prices per item. example: add: type: array description: Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array. example: items: type: string remove: type: array description: Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array. example: items: type: string replace: type: array items: $ref: '#/components/schemas/Replace1' description: Array with information about the `replace` operation, when applicable. date: type: string description: Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-27T17:52:18.6483116Z' origin: $ref: '#/components/schemas/OriginV2' settings: $ref: '#/components/schemas/Settings' Replace1: title: Replace1 required: - from - to type: object properties: from: $ref: '#/components/schemas/From1' to: $ref: '#/components/schemas/To1' example: from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: measurementUnit: unitMultiplier: 0 sellingPrice: name: detailUrl: imageUrl: shippingData: logisticsInfo: [] to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: productRefId: refId: ean: name: skuName: modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: productCategories: {} quantity: 1 seller: sellerChain: - imageUrl: detailUrl: components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: shipsTo: [] itemId: '1' deliveryChannels: [] price: 600 listPrice: 600 shippingEstimate: dockEstimate: shippingEstimateDate: lockTTL: deliveryCompany: polygonName: transitTime: sellingPrice: 600 deliveryIds: [] deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: From1: title: From1 required: - paymentData - items - shippingData type: object properties: paymentData: $ref: '#/components/schemas/PaymentDataV2' items: type: array items: $ref: '#/components/schemas/Item2V2' shippingData: $ref: '#/components/schemas/ShippingData1' example: paymentData: transactions: [] items: - id: '31' quantity: 1 price: measurementUnit: unitMultiplier: 0 sellingPrice: name: detailUrl: imageUrl: shippingData: logisticsInfo: [] PaymentDataV2: title: PaymentDataV2 required: - transactions type: object properties: transactions: type: array items: type: string example: description: Array containing financial information. This is an optional field. example: transactions: [] Item2V2: title: Item2V2 required: - id - quantity - price - measurementUnit - unitMultiplier - sellingPrice - name - detailUrl - imageUrl type: object properties: id: type: string description: SKU ID of the item been replaced. example: '1' quantity: type: integer description: Quantity of items been replaced. example: 1 price: type: string nullable: true description: Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents. example: 1000 measurementUnit: type: string nullable: true description: Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items. example: kg unitMultiplier: type: integer description: Unit multiplier for item been update. example: 3 sellingPrice: type: string description: Selling price of the item been replaced. example: 100 name: type: string nullable: true description: Name of the item been replaced. example: T-shirt with logo detailUrl: type: string nullable: true description: URL slug of the item been replaced. example: /tshirt-logo/p imageUrl: type: string nullable: true description: Image URL slug of the item been replaced. example: http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367 example: id: '31' quantity: 1 price: measurementUnit: unitMultiplier: 0 sellingPrice: name: detailUrl: imageUrl: ShippingData1: title: ShippingData1 required: - logisticsInfo type: object properties: logisticsInfo: type: array items: type: string description: Array with logistics information about the order been replaced. If not sent in the original request, it will be an empty array in the response. example: logisticsInfo: [] To1: title: To1 required: - items - paymentData - receiptData - shippingData type: object properties: items: type: array items: $ref: '#/components/schemas/Item3' description: Array containing information about the item replacing the previous one. paymentData: $ref: '#/components/schemas/PaymentDataV2' receiptData: type: object nullable: true description: Information about the receipt after order change. example: shippingData: $ref: '#/components/schemas/ShippingData2' example: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: productRefId: refId: ean: name: skuName: modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: productCategories: {} quantity: 1 seller: sellerChain: - imageUrl: detailUrl: components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: shipsTo: [] itemId: '1' deliveryChannels: [] price: 600 listPrice: 600 shippingEstimate: dockEstimate: shippingEstimateDate: lockTTL: deliveryCompany: polygonName: transitTime: sellingPrice: 600 deliveryIds: [] deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: Item3: title: Item3 required: - uniqueId - id - productId - productRefId - refId - ean - name - skuName - modalType - parentItemIndex - parentAssemblyBinding - assemblies - priceValidUntil - tax - price - listPrice - manualPrice - manualPriceAppliedBy - sellingPrice - rewardValue - isGift - additionalInfo - preSaleDate - productCategoryIds - productCategories - quantity - seller - sellerChain - imageUrl - detailUrl - components - bundleItems - attachments - attachmentOfferings - offerings - priceTags - availability - measurementUnit - unitMultiplier - manufacturerCode - priceDefinition type: object properties: uniqueId: type: string description: Item's unique ID in the change order request. example: 40E763F4378E4F40AD1FE915FE1078E1 id: type: string description: SKU ID of the item replacing the previous one. example: '3' productId: type: string nullable: true description: Product ID of the item replacing the previous one. example: '7' productRefId: type: string nullable: true description: Product Ref ID of the item replacing the previous one. example: smallcup refId: type: string nullable: true description: Reference ID of the item replacing the previous one. example: '356' ean: type: string nullable: true description: European Article Number (EAN) of the item replacing the previous one. example: '8745121641680' name: type: string nullable: true description: Name of the Product associated with the item replacing the previous one. example: Small cup of coffee with pink logo skuName: type: string nullable: true description: Name of the SKU replacing the previous one. example: Small blue cup modalType: type: string nullable: true description: A [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) attaches an unusual product, such as meat or glass, to a carrier specialized in shipping it. example: GLASS parentItemIndex: type: integer nullable: true description: Parent item index of the item replacing the previous one. example: 0 parentAssemblyBinding: type: string nullable: true description: Parent assembly binding of the item replacing the previous one. example: assemblies: type: array items: type: string description: Array with information about services that may be offered for the item replacing the previous one. For example, the assembly of a piece of furniture or warranty. nullable: true priceValidUntil: type: string nullable: true description: Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`. example: '2023-03-01T22:58:28.143' tax: type: integer description: Tax in cents of the item replacing the previous one, when applicable. example: 0 price: type: string nullable: true description: Final price of the item replacing the previous one, calculated in cents. example: 600 listPrice: type: string nullable: true description: Item's price list for the item replacing the previous one. example: 600 manualPrice: type: integer nullable: true description: Manual price of the item replacing the previous one. It is calculated in cents. example: 6500 manualPriceAppliedBy: type: string nullable: true description: User ID or appKey that made the manual price change of the item replacing the previous one. example: 4cc81d44-e42e-464b-8199-1e883bf4ab6b sellingPrice: type: integer nullable: true description: Selling price of the item replacing the previous one. It is calculated in cents. example: 600 rewardValue: type: integer description: Reward value of the item replacing the previous one. It is calculated in cents. example: 50 isGift: type: boolean description: This field is `true` when the replacing item is a gift in the order context and `false` when it is not. example: false additionalInfo: $ref: '#/components/schemas/AdditionalInfoV2' preSaleDate: type: string nullable: true description: Pre sale date of the item replacing the previous one. example: '2023-01-01T00:00:00.0000000+00:00' productCategoryIds: type: string nullable: true description: 'Replacing item''s category path composed of category IDs separated by `/`. For example: `/3/15/`.' example: /2/ productCategories: type: object description: 'Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.' example: '2': Clothes quantity: type: integer description: Quantity of replacing items. example: 1 seller: type: string nullable: true description: Seller ID that identifies the seller the replacing item belongs to. example: '1' sellerChain: type: array items: type: string nullable: true description: Array containing information about sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) order. imageUrl: type: string nullable: true description: Image URL slug of the replacing item. example: http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363 detailUrl: type: string nullable: true description: URL slug of the replacing item. example: /cup-coffee/p components: type: array items: type: string description: Array with information about replacing item's components. bundleItems: type: array items: type: string description: Array with information about services sold along with the replacing item, such as a gift package. attachments: type: array items: type: string description: Array containing information on attachments. attachmentOfferings: type: array items: type: string description: Array with the properties of the content declared in the field `attachments`. offerings: type: array items: type: string description: Array with replacing items Item's offerings. priceTags: type: array items: type: string description: Array containing objects with replacing item's price modifiers. availability: type: string nullable: true description: Availability to fulfill the order with the item. example: available measurementUnit: type: string description: Replacing item's measurement unit. example: un unitMultiplier: type: integer description: Replacing item's unit multiplier. example: 1 manufacturerCode: type: string nullable: true description: Provided by the manufacturers to identify their product. This field should be completed if the replacing item has a manufacturer's code. example: manf-00005 priceDefinition: type: string nullable: true description: replacing item's price information. example: example: uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: productRefId: refId: ean: name: skuName: modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: productCategories: {} quantity: 1 seller: sellerChain: - imageUrl: detailUrl: components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: AdditionalInfoV2: title: AdditionalInfoV2 required: - dimension - brandName - brandId - offeringInfo - offeringType - offeringTypeId - categoriesIds - productClusterId - commercialConditionId type: object properties: dimension: type: string nullable: true description: Replacing tem's dimensions in the measure unit configured in the catalog. example: brandName: type: string nullable: true description: Replacing item's brand name. example: Special coffee cup brandId: type: string nullable: true description: Replacing item's brand ID. example: '2000001' offeringInfo: type: string nullable: true description: Offering information. example: offeringType: type: string nullable: true description: Offering type. example: offeringTypeId: type: string nullable: true description: Offering type ID. example: categoriesIds: type: string nullable: true description: ID of the replacing item product category. example: productClusterId: type: string nullable: true description: All product clusters related to the replacing item. example: 135,137,143,518,1272 commercialConditionId: type: string nullable: true description: Replacing item commercial conditions ID. example: '5' example: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: ShippingData2: title: ShippingData2 required: - logisticsInfo type: object properties: logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfo1' description: Array with shipping information. example: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: shipsTo: [] itemId: '1' deliveryChannels: [] price: 600 listPrice: 600 shippingEstimate: dockEstimate: shippingEstimateDate: lockTTL: deliveryCompany: polygonName: transitTime: sellingPrice: 600 deliveryIds: [] deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: LogisticsInfo1: title: LogisticsInfo1 required: - itemIndex - selectedSla - selectedDeliveryChannel - addressId - slas - shipsTo - itemId - deliveryChannels - price - listPrice - shippingEstimate - dockEstimate - shippingEstimateDate - lockTTL - deliveryCompany - polygonName - transitTime - sellingPrice - deliveryIds - deliveryWindow - pickupPointId - pickupStoreInfo - pickupDistance type: object properties: itemIndex: type: integer description: Index that identifies the position of the replacing item in the array, starting from `0`. example: 0 selectedSla: type: string description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order. example: Normal selectedDeliveryChannel: type: string description: Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`. example: delivery addressId: type: string description: Shipping address ID of the replacing item. example: 9ec276fd3a604eb1aa151b5333ca5db7 slas: type: array items: $ref: '#/components/schemas/SlaV2' description: Information on Service Level Agreement (SLA) of the change order shipping policy. shipsTo: type: array items: type: string description: Country name represented in a three letters code ISO 3166 ALPHA-3. example: BRA description: List of countries of the change order shipping address. itemId: type: string description: Replacing item's SKU ID, which is a unique numerical identifier. example: '3' deliveryChannels: type: array items: $ref: '#/components/schemas/DeliveryChannel' description: Array with the delivery channels associated with the trade policy. price: type: integer description: Replacing item's final price, calculated in cents. example: 600 listPrice: type: integer description: Replacing item's price list, calculated in cents. example: 600 shippingEstimate: type: string nullable: true description: Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-29T17:52:18.6483116Z' dockEstimate: type: string nullable: true description: Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`. example: 1bd shippingEstimateDate: type: string nullable: true description: Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`. example: 3bd lockTTL: type: string nullable: true description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`. example: 1bd deliveryCompany: type: string nullable: true description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.' example: Correios polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. example: 114 - Polanco _ H-05 transitTime: type: string nullable: true description: Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`. example: 3bd sellingPrice: type: integer description: Change item's selling price. example: 600 deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryIdV2' description: Array with delivery information. deliveryWindow: type: string nullable: true description: Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable. example: pickupPointId: type: string nullable: true description: ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). example: pup215rkw pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfoV2' pickupDistance: type: number nullable: true description: Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. example: '1.0' example: itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: shipsTo: [] itemId: '1' deliveryChannels: [] price: 600 listPrice: 600 shippingEstimate: dockEstimate: shippingEstimateDate: lockTTL: deliveryCompany: polygonName: transitTime: sellingPrice: 600 deliveryIds: [] deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: SlaV2: title: SlaV2 required: - id - deliveryChannel - name - deliveryIds - shippingEstimate - shippingEstimateDate - lockTTL - availableDeliveryWindows - deliveryWindow - price - listPrice - tax - pickupStoreInfo - pickupPointId - pickupDistance - polygonName - transitTime type: object properties: id: type: string description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. example: Normal deliveryChannel: type: string description: Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery. example: delivery name: type: string description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value. example: Normal deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryIdV2' description: Information about delivery IDs. shippingEstimate: type: string nullable: true description: Total shipping duration estimated in days. For instance, three business days is represented as `3bd`. example: 3bd shippingEstimateDate: type: string nullable: true description: Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-27T17:52:18.6483116Z' lockTTL: type: string nullable: true description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`. example: 1bd availableDeliveryWindows: type: array items: type: string description: Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations. deliveryWindow: type: object nullable: true description: '[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.' example: price: type: integer description: Shipping price for the item in cents. Does not account for the whole order's shipping price. example: 600 listPrice: type: integer description: Item's price list for a specific trade policy. example: 600 tax: type: integer description: Tax in cents, when applicable. example: 0 pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfoV2' pickupPointId: type: string nullable: true description: Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA. example: pup215rkw pickupDistance: type: number nullable: true description: Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. example: 1 polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. example: 114 - Polanco _ H-05 transitTime: type: string nullable: true description: Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days is represented as `3bd`. example: 3bd example: id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: [] shippingEstimate: shippingEstimateDate: lockTTL: availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 600 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: transitTime: PickupStoreInfoV2: title: PickupStoreInfoV2 required: - isPickupStore - friendlyName - address - additionalInfo - dockId type: object properties: isPickupStore: type: boolean description: This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated. example: false nullable: true deprecated: true friendlyName: type: string description: Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated. example: nullable: true deprecated: true address: type: string nullable: true description: Address of the loading dock converted to pickup point. This field has been deprecated. example: deprecated: true additionalInfo: type: string nullable: true description: Additional information about the loading dock converted to pickup point. This field has been deprecated. example: deprecated: true dockId: type: string nullable: true description: ID of the loading dock converted to pickup point. This field has been deprecated. example: deprecated: true deprecated: true example: isPickupStore: false friendlyName: address: additionalInfo: dockId: dockAjs28 OriginV2: title: OriginV2 required: - account - orderId - component type: object properties: account: type: string description: Name of the account where the order was made. example: qastore orderId: type: string description: Order ID is a unique code that identifies an order. example: v12772213qst-02 component: type: string description: Component information. example: MarketplaceComponent description: Object containing information about the order origin. example: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent Settings: title: Settings required: - customPaymentSystemsAllowed type: object properties: customPaymentSystemsAllowed: type: array items: type: string description: Store's [custom payment](https://help.vtex.com/tutorial/how-to-configure-a-custom-payment--tutorials_451) information. Applicable only for stores that configured custom payment options. example: [] example: customPaymentSystemsAllowed: [] GetChangeHistory: title: GetChangeHistory required: - requests - actions type: object properties: requests: type: array items: $ref: '#/components/schemas/Request' description: Array with change order requests details. actions: type: array items: type: string description: Array containing actions information. example: requests: - requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] actions: [] Request: title: Request required: - requestId - workflowId - reason - manualDiscountValue - manualIncrementValue - totalChangeValue - totals - add - remove - replace - date - origin - settings type: object properties: requestId: type: string description: Unique code that identifies an order change. example: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: type: string description: Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). example: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: type: string description: Reason that motivated the order change. example: The client wants to change the items weight. manualDiscountValue: type: integer description: This field shows if it was applied a manual price for the total order amount. The value is in cents. example: 0 manualIncrementValue: type: integer description: This field shows if an increment value was applied to the total order amount. The value is in cents. example: 0 totalChangeValue: type: integer description: This field shows how much the order total price is, considering that price changes might have been made. The value is in cents. example: 0 totals: type: array items: type: string description: Array containing information about change prices per item. add: type: object nullable: true description: Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`. example: remove: type: object nullable: true description: Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`. example: replace: type: array items: $ref: '#/components/schemas/Replace2' description: Array with information about the replacement operation performed. date: type: string description: Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-27T17:52:18.6483116Z' origin: $ref: '#/components/schemas/OriginV2' settings: $ref: '#/components/schemas/Settings' example: requestId: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: 74f40e7a-68c6-4699-b874-a8a297fb3f6a reason: The client did not like the size. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 0 totals: [] add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T17:52:18.6483116Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] Replace2: title: Replace2 required: - from - to type: object properties: from: $ref: '#/components/schemas/From2' to: $ref: '#/components/schemas/To2' example: from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: From2: title: From2 required: - paymentData - items - shippingData type: object properties: paymentData: $ref: '#/components/schemas/PaymentDataV2' items: type: array items: $ref: '#/components/schemas/Item4' shippingData: $ref: '#/components/schemas/ShippingData3' example: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: Item4: title: Item4 required: - id - quantity - price - measurementUnit - unitMultiplier - sellingPrice - name - detailUrl - imageUrl type: object properties: id: type: string description: SKU ID of the item. example: '1' quantity: type: integer description: Quantity of items been replaced. example: 1 price: type: string nullable: true description: Item's shipping price. It does not account for the whole order's shipping price and is presented in cents. example: 1000 measurementUnit: type: string nullable: true description: Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items. example: kg unitMultiplier: type: integer description: Item's unit multiplier. example: 3 sellingPrice: type: string description: Item's selling price. example: 100 name: type: string nullable: true description: Item's name. example: T-shirt with logo detailUrl: type: string nullable: true description: Item's URL slug. example: /tshirt-logo/p imageUrl: type: string nullable: true description: Item's image URL slug. example: http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367 example: id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 ShippingData3: title: ShippingData3 required: - logisticsInfo type: object properties: logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfo2' description: Array with shipping information. example: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: LogisticsInfo2: title: LogisticsInfo2 required: - itemIndex - selectedSla - selectedDeliveryChannel - addressId - slas - shipsTo - itemId - deliveryChannels - price - listPrice - shippingEstimate - dockEstimate - shippingEstimateDate - lockTTL - deliveryCompany - polygonName - transitTime - sellingPrice - deliveryIds - deliveryWindow - pickupPointId - pickupStoreInfo - pickupDistance type: object properties: itemIndex: type: integer description: Index that identifies the position of the replacing item in the array, starting from `0`. example: 0 selectedSla: type: string description: Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order. example: Normal selectedDeliveryChannel: type: string description: Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`. example: delivery addressId: type: string description: Shipping address ID. example: 9ec276fd3a604eb1aa151b5333ca5db7 slas: type: array items: $ref: '#/components/schemas/SlaV2' description: Information on Service Level Agreement (SLA) of the change order. shipsTo: type: array items: type: string description: Country name represented in a three letters code ISO 3166 ALPHA-3. example: BRA description: List of countries of the change order shipping address. itemId: type: string description: Replacing item's SKU ID, which is a unique numerical identifier. example: '3' deliveryChannels: type: array items: $ref: '#/components/schemas/DeliveryChannel' description: Array with the delivery channels associated with the trade policy. price: type: integer description: Item's final price, calculated in cents. example: 600 listPrice: type: integer description: Item's price list, calculated in cents. example: 600 shippingEstimate: type: string nullable: true description: Item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-29T17:52:18.6483116Z' dockEstimate: type: string nullable: true description: Item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`. example: 1bd shippingEstimateDate: type: string nullable: true description: Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`. example: 3bd lockTTL: type: string nullable: true description: Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`. example: 1bd deliveryCompany: type: string nullable: true description: '[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company''s name.' example: Correios polygonName: type: string nullable: true description: Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. example: 114 - Polanco _ H-05 transitTime: type: string nullable: true description: Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`. example: 3bd sellingPrice: type: integer description: Item's selling price. example: 600 deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryIdV2' description: Array with delivery information. deliveryWindow: type: string nullable: true description: Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable. example: pickupPointId: type: string nullable: true description: ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). example: pup215rkw pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfoV2' pickupDistance: type: number nullable: true description: Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. example: '1.0' example: itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: DeliveryIdV2: title: DeliveryIdV2 required: - courierId - warehouseId - dockId - courierName - quantity - kitItemDetails - accountCarrierName type: object properties: courierId: type: string description: ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). example: 136769c warehouseId: type: string description: ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). example: w_156 dockId: type: string description: ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj). example: ld931 courierName: type: string description: Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). example: Crossborder quantity: type: integer description: Quantity of items. example: 1 kitItemDetails: type: array items: type: string description: Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order. example: nullable: true accountCarrierName: type: string nullable: true description: Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE). example: vtexlog example: courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: DeliveryChannel: title: DeliveryChannel required: - id type: object properties: id: type: string description: Change order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery. example: delivery example: id: delivery To2: title: To2 required: - items - paymentData - receiptData - shippingData type: object properties: items: type: array items: $ref: '#/components/schemas/Item3' description: Array containing information about the item replacing the previous one. paymentData: $ref: '#/components/schemas/PaymentDataV2' receiptData: type: object nullable: true description: Information about the receipt after order change. example: shippingData: $ref: '#/components/schemas/ShippingData3' example: items: - uniqueId: 40E763F4378E4F40AD1FE915FE1078E1 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: PriceDefinition: title: PriceDefinition required: - calculatedSellingPrice - total - sellingPrices type: object properties: calculatedSellingPrice: type: integer total: type: integer sellingPrices: type: array items: $ref: '#/components/schemas/SellingPrice' description: Array containing selling price information. example: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 SellingPrice: title: SellingPrice required: - value - quantity type: object properties: value: type: integer quantity: type: integer example: value: 5000 quantity: 1 GetChangeDetail: title: GetChangeDetail required: - requestId - workflowId - status - inProgress - reason - manualDiscountValue - manualIncrementValue - totalChangeValue - totals - add - remove - replace - date - origin - settings type: object properties: requestId: type: string description: Unique code that identifies a change order request. example: e8532a32-7f7e-434a-88ec-29609f0ede46 workflowId: type: string description: Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). example: 74f40e7a-68c6-4699-b874-a8a297fb3f6a status: type: string description: Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). example: handling inProgress: type: boolean description: When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the shopper received it. example: true reason: type: string description: Reason that motivated the order change. example: The client wants to change the items weight. manualDiscountValue: type: integer description: This field shows if a manual price was applied to the total order amount. The value is in cents. example: 0 manualIncrementValue: type: integer description: This field shows if an increment value was applied to the total order amount. The value is in cents. example: 0 totalChangeValue: type: integer description: This field shows how much is the order total price considering that price changes might have been made. The value is in cents. example: 0 totals: type: array items: type: string description: Array containing information about change prices per item. example: add: type: array description: Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array. example: items: type: string remove: type: array description: Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array. example: items: type: string replace: type: array items: $ref: '#/components/schemas/Replace1' description: Array with information about the `replace` operation, when applicable. date: type: string description: Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`. example: '2023-07-27T17:52:18.6483116Z' origin: $ref: '#/components/schemas/OriginV2' settings: $ref: '#/components/schemas/Settings' PreviewChange: title: PreviewChange required: - reason - replace type: object properties: reason: type: string description: Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). example: The client wants to change a weighable product. replace: type: array items: $ref: '#/components/schemas/Replace' description: Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request. example: reason: The client wants to change a weighable product. replace: - from: items: - id: '1' quantity: 1 to: items: - id: '1' quantity: 1 measurementUnit: kg unitMultiplier: 1 shippingData: logisticsInfo: - itemIndex: 0 slaId: Normal deliveryChannel: delivery addressId: '12334048475146857' price: 1000 PreviewChange1: title: PreviewChange1 required: - reason - manualDiscountValue - manualIncrementValue - totalChangeValue - totals - add - remove - replace - date - origin - settings type: object properties: reason: type: string manualDiscountValue: type: integer manualIncrementValue: type: integer totalChangeValue: type: integer totals: type: array items: $ref: '#/components/schemas/TotalV2' description: Array containing totals information. add: type: string nullable: true remove: type: string nullable: true replace: type: array items: $ref: '#/components/schemas/Replace2' description: Array containing replace information. date: type: string origin: $ref: '#/components/schemas/OriginV2' settings: $ref: '#/components/schemas/Settings' example: reason: I would like to receive a preview. manualDiscountValue: 0 manualIncrementValue: 0 totalChangeValue: 420 totals: - id: ManualValues name: Manual Values Total value: 0 - id: Shipping name: Shipping Total value: 420 add: remove: replace: - from: paymentData: transactions: [] items: - id: '31' quantity: 1 price: 5000 measurementUnit: un unitMultiplier: 1 sellingPrice: 5000 name: Fusca miniatura Fusca preto detailUrl: /fusca-miniatura-24/p imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000 shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 180 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '31' deliveryChannels: - id: delivery price: 180 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 180 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: to: items: - uniqueId: 303A1E4534984FF295BA571BF08C8297 id: '1' productId: '1' productRefId: '' refId: codrefxicaraazul ean: '8745121641' name: xícara azul skuName: azul modalType: parentItemIndex: parentAssemblyBinding: assemblies: [] priceValidUntil: tax: 0 price: 5000 listPrice: manualPrice: manualPriceAppliedBy: sellingPrice: 5000 rewardValue: 0 isGift: false additionalInfo: dimension: brandName: brandId: offeringInfo: offeringType: offeringTypeId: categoriesIds: productClusterId: commercialConditionId: preSaleDate: productCategoryIds: /1/ productCategories: '1': Category quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000 detailUrl: /xicara/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: measurementUnit: un unitMultiplier: 1 manufacturerCode: priceDefinition: calculatedSellingPrice: 5000 total: 5000 sellingPrices: - value: 5000 quantity: 1 paymentData: transactions: [] receiptData: shippingData: logisticsInfo: - itemIndex: 0 selectedSla: Lenta selectedDeliveryChannel: delivery addressId: 9ec276fd3a604eb1aa151b5333ca5db6 slas: - id: Lenta deliveryChannel: delivery name: Lenta deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 600 listPrice: 180 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 3bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 500 listPrice: 500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 3bd - id: Pickup deliveryChannel: delivery name: Pickup deliveryIds: - courierId: ech018654 warehouseId: '1_1' dockId: '1' courierName: Retirada quantity: 1 kitItemDetails: [] accountCarrierName: shippingEstimate: 25bd shippingEstimateDate: lockTTL: 12d availableDeliveryWindows: [] deliveryWindow: price: 700 listPrice: 700 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupPointId: pickupDistance: polygonName: '' transitTime: 25bd shipsTo: - BRA itemId: '1' deliveryChannels: - id: delivery price: 600 listPrice: 180 shippingEstimate: 25bd dockEstimate: shippingEstimateDate: '2023-08-30T10:17:24.6436519Z' lockTTL: 12d deliveryCompany: polygonName: '' transitTime: 25bd sellingPrice: 600 deliveryIds: - courierId: 1c083bf warehouseId: '1_1' dockId: '1' courierName: Donkey quantity: 1 kitItemDetails: accountCarrierName: qastoreecho deliveryWindow: pickupPointId: pickupStoreInfo: isPickupStore: false friendlyName: address: additionalInfo: dockId: pickupDistance: date: '2023-07-27T18:01:26.4743309Z' origin: account: qastore orderId: v12772213qst-02 component: MarketplaceComponent settings: customPaymentSystemsAllowed: [] TotalV2: title: TotalV2 required: - id - name - value type: object properties: id: type: string name: type: string value: type: integer example: id: ManualValues name: Manual Values Total value: 0 CancelChangeStoppedonError: title: CancelChangeStoppedonError required: - reason type: object properties: reason: type: string description: Reason why you wish to cancel the order change. The customer will not view the value inserted in this field. example: I want to cancel this change order request because it's stopped on a blocking error. example: reason: I want to cancel this change order request because it's stopped on a blocking error. Error: title: Error required: - code - message type: object properties: code: type: string message: type: string example: code: '001' message: An error with Workflow System has occurred tags: - name: Change Order (Beta) - name: Change Seller - name: Conversation - name: Feed V2 (Deprecated) - name: Feed V3 - name: Invoice - name: Order Hook - name: Orders - name: Payment - name: Tracking - name: User Orders