openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Orders API description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: Orders 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: null - 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: null 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: null 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: null 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: null 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: null cardNumber: null firstDigits: '444433' lastDigits: '1111' cvv2: '351' expireMonth: '12' expireYear: '2029' url: null giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null 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: null deliveryCompany: All CEPs shippingEstimate: 4bd shippingEstimateDate: '2024-03-09T10:13:40.1020453+00:00' slas: - id: Normal name: Normal shippingEstimate: 4bd deliveryWindow: null price: 3000 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 10d pickupPointId: 1_store-RJ transitTime: 3d pickupDistance: 0 - id: Express name: Express shippingEstimate: 2bd deliveryWindow: null price: 3000 deliveryChannel: pickup-in-point pickupStoreInfo: additionalInfo: Arrive soon address: addressType: pickup receiverName: null addressId: VTEX-RJ versionId: null entityId: null postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: 4th floor reference: null 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: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '3206601248910' versionId: null entityId: null polygonName: '' pickupPointId: null 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: null 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: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5660c55f-714d-4b14-88a7-b03e9bfbdd2y userProfileVersion: b98d1d7b-4075-4d88-81e5-418d36b078g3 customerClass: null customerCode: 933d29f5-c7c5-4d12-b0c8-c30079c33b21 items: - uniqueId: 94913BB553334977BFD669A24E678C69 id: '18' productId: '6' ean: '3256873' lockId: 00-1415461749731-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGBML price: 990 listPrice: 1990 manualPrice: null 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: null 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: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 990 isGift: false shippingPrice: null rewardValue: 1599 freightCommission: 0 priceDefinition: sellingPrices: - value: 990 quantity: 1 calculatedSellingPrice: 990 total: 990 reason: null taxCode: product_Free parentItemIndex: 0 parentAssemblyBinding: assembly_product_warranty callCenterOperator: null serialNumbers: null 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: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: null totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: null totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null 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: null nullable: true example: error: code: '1' message: Acesso não autorizado exception: null '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: null '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/orders/pvt/document/{orderId}: get: tags: - Orders summary: VTex Get order description: "Retrieves order details by searching a specific order ID.\n\r\n\r>If you wish to retrieve unmasked data, use the `reason` parameter.\n\r\n\r> The `View order` 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#).\n\r\n\r> 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.\n\r\n\r> Throttling: Each account can make up to 5000 requests per minute.\n\r\n\r## Request object has the following properties:\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `orderId` | string | Order Id |\r\n\r\n\r\n## Response object has the following properties:\r\n\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `affiliateId` | string | Seller Name who was responsible for the order |\r\n| `allowCancellation` | boolean | If Cancellation is allowed |\r\n| `allowEdition` | boolean | If Order Edition is allowed |\r\n| `approvedBy` | string | User who approved the order |\r\n| `authorizedDate` | string | Authorized Order Date |\r\n| `callCenterOperatorData` | string | Call Center Operator responsible for the order |\r\n| `cancelReason` | string | Cancel Reason |\r\n| `cancelledBy` | string | User who Cancelled the order |\r\n| `changesAttachment` | object | Change details object |\r\n| `changesData` | object | Array with each change |\r\n| `discountValue` | integer | Change Discount Value |\r\n| `incrementValue` | integer | Change Increment Value |\r\n| `itemsAdded` | object | Added items details |\r\n| `itemsRemoved` | object | Removed items details |\r\n| `id` | integer | Changed SKU ID |\r\n| `name` | string | Changed SKU Name |\r\n| `price` | integer | Changed SKU Price |\r\n| `quantity` | integer | Changed SKU Quantity |\r\n| `unitMultiplier` | integer | Changed SKU Unit Multiplier |\r\n| `reason` | string | Change Reason |\r\n| `receipt` | object | Change receipt details object |\r\n| `date` | string | Change receipt date |\r\n| `orderId` | string | Change receipt order Id |\r\n| `receipt` | object | Change receipt ID |\r\n| `id` | string | Object Id, expect value \"changeAttachment\" |\r\n| `clientProfileData` | object | Object with all Cliente Profile Data |\r\n| `corporateDocument` | string | Client Corporate Document |\r\n| `corporateName` | string | Client Corporate Name |\r\n| `corporatePhone` | string | Cliente Corporate Telephone |\r\n| `customerClass` | string | Customer class |\r\n| `document` | string | Client Document |\r\n| `documentType` | string | Client Document Type |\r\n| `email` | string | Client e-mail |\r\n| `firstName` | string | Client First Name |\r\n| `id` | string | Object ID, expected value \"clientProfileData\" |\r\n| `isCorporate` | string | If the Client is a Corporate Client |\r\n| `lastName` | string | Client Last Name|\r\n| `phone` | string | Client Telephone |\r\n| `stateInscription` | string | Client Corporate Inscription |\r\n| `tradeName` | string | Client Corporate Trade Name |\r\n| `userProfileId` | string | Client User Profile ID |\r\n| `commercialConditionData` | object | Commercial condition information, including `\"Id\"`, `\"parentOrderId\"`, and `\"reason\"` |\r\n| `creationDate` | string | Order Creation Date |\r\n| `customData` | object | Custom Data Object |\r\n| `customApps` | object | Custom apps details object |\r\n| `fields` | object | Custom app fields |\r\n| `id` | string | Custom App ID |\r\n| `major` | integer | Major |\r\n| `emailTracked` | string | Client Conversation Tracker email |\r\n| `followUpEmail` | string | Responsible store e-mail |\r\n| `giftRegistryData` | object | Gift registry list information, including `\"addressId\"` (object), `\"description\"` (string), and `\"giftRegistryId\"` (string) |\r\n| `hostname` | string | Account hostname registered in License Manager |\r\n| `invoiceData` | object | Information pertinent to the order's invoice |\r\n| `invoicedDate` | string | Invoice Date |\r\n| `isCheckedIn` | boolean | True if order is from inStore |\r\n| `isCompleted` | boolean | True if the order is completed |\r\n| `items` | object | Order items object |\r\n| `additionalInfo` | string | Order item additional info |\r\n| `brandId` | string | Brand ID |\r\n| `brandName` | string | Brand name |\r\n| `categoriesIds` | string | Item category ID |\r\n| `commercialConditionId` | string | Invoice date |\r\n| `dimension` | object | Item dimension object |\r\n| `cubicweight` | number | Item cubic weight |\r\n| `height` | number | Item height |\r\n| `length` | number | Item length |\r\n| `weight` | number | Item weight |\r\n| `width` | number | Item width |\r\n| `offeringInfo` | string | Extra information on offering |\r\n| `offeringType` | string | Offering type |\r\n| `offeringTypeId` | string | ID of offering type |\r\n| `productClusterId` | string | All releated product clusters |\r\n| `attachments` | object | Attachents Array |\r\n| `content` | object | Attachment Content Custom Field |\r\n| `name` | string | Attachment Name |\r\n| `bundleItems` | object | Invoice date |\r\n| `commission` | string | Comission value registered to Seller |\r\n| `components` | object | If item is a kit, contains components information |\r\n| `detailUrl` | string | Product Slug URL |\r\n| `ean` | string | SKU EAN |\r\n| `freightCommission` | integer | Comission value registered to seller |\r\n| `id` | string | SKU Id |\r\n| `imageUrl` | string | SKU Image URL |\r\n| `isGift` | string | If this item is a gift in order context |\r\n| `itemAttachment` | object | Attachment Object |\r\n| `content` | object | Attachment Content Array |\r\n| `name` | string | Attachment Name |\r\n| `listPrice` | integer | Item List Price |\r\n| `lockId` | string | Reservation ID |\r\n| `manualPrice` | string | Manually inserted price, if there is one. |\r\n| `measurementUnit` | string | Item measurement unit |\r\n| `name` | string | Item name |\r\n| `offerings` | object | Offerings information |\r\n| `params` | object | \"ContextParameter\" hashset with `\"name\"` and `\"value\"` |\r\n| `preSaleDate` | string | Item pre sale date |\r\n| `price` | integer | Item Price |\r\n| `items[].priceDefinition` | Object | Price information for all units of a specific item. |\r\n| `items[].priceDefinition.total` | Integer | Total value for all units of the item in cents. |\r\n| `items[].priceDefinition.calculatedSellingPrice` | Integer | Item's calculated unitary selling price in cents. |\r\n| `items[].priceDefinition.sellingPrices` | Array | Array of objects, each containing `value` (in cents) and `quantity` for the different rounding instances that can be combined to form the correctly rounded `total`. |\r\n| `priceTags` | object | Object with all price modifiers |\r\n| `identifier` | string | Price Tag ID |\r\n| `isPercentual` | boolean | Indicates whether the price tag is a percentual modifier |\r\n| `name` | string | Price tag name |\r\n| `rawValue` | string | Price tag raw value |\r\n| `value` | string | Price tag value |\r\n| `priceValidUntil` | string | Price expiration date |\r\n| `productId` | string | Item product ID |\r\n| `quantity` | integer | Item quantity |\r\n| `refId` | string | Item reference ID |\r\n| `rewardValue` | integer | Item reward value |\r\n| `seller` | string | Item seller |\r\n| `sellerSku` | string | Invoice Date |\r\n| `sellingPrice` | integer | Item selling price. For more accurate information, see the `priceDefinition` field |\r\n| `shippingPrice` | string | Item Shipping Price |\r\n| `tax` | integer | Item Tax |\r\n| `taxCode` | string | Item Tax Code |\r\n| `uniqueId` | string | Item Order Unique ID |\r\n| `unitMultiplier` | integer | Item Unit Multipler |\r\n| `lastChange` | string | Order Last Change Date |\r\n| `lastMessage` | string | initial excerpt from last message sent to the customer |\r\n| `marketingData` | string | Marketing Data Object |\r\n| `coupon` | string | Order Disccount Coupon |\r\n| `id` | string | Object ID, expected value \"marketingData\" |\r\n| `marketingTags` | object | Marketing Tags Array |\r\n| `utmCampaign` | string | UTM Campaign Parameters |\r\n| `utmMedium` | string | UTM Medium Parameters |\r\n| `utmPartner` | string | UTM Source Parameters |\r\n| `utmSource` | string | UTM Source Parameters|\r\n| `utmiCampaign` | string | UTMI Campaign Internal Parameters |\r\n| `utmiPart` | string | UTMI Part Internal Parameters |\r\n| `utmipage` | string | UTMI Page Internal Parameters |\r\n| `marketplace` | object | Marketplace Details Object |\r\n| `baseURL` | string | Marketplace Base URL |\r\n| `isCertified` | string | If is a Certified Marketplace |\r\n| `name` | string | Marketplace Name |\r\n| `marketplaceItems` | object | Marketplace Details Object |\r\n| `marketplaceOrderId` | string | Marketplace Order Id |\r\n| `marketplaceServicesEndpoint` | string | Marketplace Services Endpoint |\r\n| `merchantName` | string | Merchant Name |\r\n| `openTextField` | object | Open Text Field Object |\r\n| `value` | string | Open Text Field Value |\r\n| `orderFormId` | string | Order Form Id |\r\n| `orderGroup` | string | Order Group Id |\r\n| `orderId` | string | Order Id |\r\n| `origin` | string | Order Origin: \"Marketplace\", \"Fulfillment\", or \"Chain\" (for the third level in a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4?&utm_source=autocomplete#) purchase). |\r\n| `packageAttachment` | object | Package Object |\r\n| `packages` | object | Packages Details Object, populated after order invoiced |\r\n| `cfop` | string | Fiscal code for operations and installments |\r\n| `courier` | string | Package selected Courier |\r\n| `courierStatus` | string | Package Tracking Status |\r\n| `data` | object | Package Tracking Timeline |\r\n| `finished` | string | If the delivery are finished |\r\n| `status` | string | Courier Status |\r\n| `embeddedInvoice` | string | XML of the invoice |\r\n| `invoiceKey` | string | Invoice Credencial Key |\r\n| `invoiceNumber` | string | Package Invoice Number |\r\n| `invoiceUrl` | string | Package Invoice URL |\r\n| `invoiceValue` | string | Package Invoice Value |\r\n| `issuanceDate` | string | Package Issuance Date |\r\n| `items` | string | Items Package Array |\r\n| `description` | string | Item Desciprtion |\r\n| `itemIndex` | string | Item Index |\r\n| `price` | string | Item Price |\r\n| `quantity` | string | Item Quantity |\r\n| `unitMultiplier` | string | Unit Multiplier |\r\n| `trackingNumber` | string | Package Tracking Number |\r\n| `trackingUrl` | string | Tracking Order URL |\r\n| `type` | string | Invoice Type, expected values \"Output\" and \"Input\" |\r\n| `paymentData` | object | Payment Object |\r\n| `transactions` | object | Transactions Object |\r\n| `isActive` | boolean | If the payment is Active |\r\n| `merchantName` | string | Merchant Name|\r\n| `payments` | object | Payment Object |\r\n| `cardHolder` | string | Payment Card Holder |\r\n| `connectorResponses` | object | Connector Responses Object |\r\n| `billingAddress` | object | Billing Address information |\r\n| `Message` | string | Connector Responses Message |\r\n| `ReturnCode` | string | Connector Return Code |\r\n| `Tid` | string | Connector Transaction ID |\r\n| `acquirer` | string | Connector acquirer |\r\n| `authId` | string | Connector authorization ID |\r\n| `dueDate` | string | Payment due date |\r\n| `firstDigits` | string | Payment card first digits |\r\n| `giftCardCaption` | string | Gift card caption |\r\n| `giftCardId` | string | Gift card ID |\r\n| `giftCardName` | string | Gift card name |\r\n| `group` | string | Payment group |\r\n| `id` | string | Payment ID |\r\n| `installments` | string | Payment installments quantity |\r\n| `lastDigits` | string | Payment card last digits |\r\n| `paymentSystem` | string | Payment system type ID |\r\n| `paymentSystemName` | string | Payment system name |\r\n| `redemptionCode` | string | Gift card redemption code |\r\n| `referenceValue` | string | Payment reference value |\r\n| `tid` | string | Payment transaction ID |\r\n| `url` | string | Payment URL |\r\n| `value` | string | Payment value with interest if it applies |\r\n| `transactionId` | string | Transaction Id |\r\n| `ratesAndBenefitsData` | string | Rates and Benefits Data Object |\r\n| `id` | string | Object ID, expected value \"ratesAndBenefitsData\" |\r\n| `rateAndBenefitsIdentifiers` | object | Rates and Benefits Details Object |\r\n| `additionalInfo` | string | Rates and Benefits Additional Info |\r\n| `description` | string | Rates and Benefits Description |\r\n| `featured` | string | If is allowed to acumulate the Rates and Benefits |\r\n| `matchedParameters` | object | March Parameters Array |\r\n| `name` | string | Rates and Benefits Name |\r\n| `roundingError` | integer | Rounding Error Total Amount |\r\n| `salesChannel` | string | Order Sales Channel Id |\r\n| `sellerOrderId` | string | Order Seller Id |\r\n| `sellers` | object | Sellers Array |\r\n| `id` | string | Seller Id |\r\n| `logo` | string | URL Seller Logo |\r\n| `name` | string | Seller Name |\r\n| `sequence` | string | Order Sequence ID |\r\n| `shippingData` | object | Shipping Data Object |\r\n| `address` | object | Shipping Address |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `id` | string | Object ID, expected value \"shippingData\"|\r\n| `logisticsInfo` | object | Logistics Info Object |\r\n| `addressId` | string | Adress Id |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryCompany` | string | Courier Company Name |\r\n| `deliveryIds` | object | Delivery Ids Object |\r\n| `courierId` | string | Courier Id |\r\n| `courierName` | string | Courier Name |\r\n| `dockId` | string | Releated Dock Id |\r\n| `quantity` | integer | Items Quantity |\r\n| `warehouseId` | string | Releated Warehouse Id |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `itemIndex` | integer | Logistic Info Item Index |\r\n| `listPrice` | integer | Logistic Info Item List Price |\r\n| `lockTTL` | string | Stock reservation waiting period |\r\n| `pickupStoreInfo` | object | Pickup Store Info Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store Releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygom Name |\r\n| `price` | integer | Logistic Info Item Price |\r\n| `selectedSla` | string | Selected SLA |\r\n| `sellingPrice` | integer | Logistic Info Item Selling Price |\r\n| `shippingEstimate` | string | Estimate Shipping Duration |\r\n| `shippingEstimateDate` | string | Estimate Shipping Date |\r\n| `shipsTo` | object | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `slas` | object | SLAs Object |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `id` | string | SLA Id |\r\n| `pickupStoreInfo` | object | Pickup Store Details Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygon Name |\r\n| `price` | integer | SLA Price |\r\n| `shippingEstimate` | string | SLA Shipping Estimate |\r\n| `selectedAddresses` | object | Selected Address Details Object |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `trackingHints` | array | Array of tracking hint objects, containing `\"courierName\"`, `\"trackingId\"`, `\"trackingLabel\"`, and `\"trackingUrl\"` |\r\n| `status` | string | Order Status |\r\n| `statusDescription` | string | Status Description |\r\n| `storePreferencesData` | object | Store Preferences Data Object |\r\n| `countryCode` | string | Country Code in ISO 3166 ALPHA-3 abbreviation |\r\n| `currencyCode` | string | Currency Code in ISO 4217 |\r\n| `currencyFormatInfo` | object | Currency Format Info Object |\r\n| `CurrencyDecimalDigits` | integer | Currency Decimal Digits |\r\n| `CurrencyDecimalSeparator` | string | Currency Decimal Separator |\r\n| `CurrencyGroupSeparator` | string | Currency Group Separator |\r\n| `CurrencyGroupSize` | integer | Currency Group Size |\r\n| `StartsWithCurrencySymbol` | boolean | If Starts With Currency Symbol |\r\n| `currencyLocale` | integer | LCID Decimal |\r\n| `currencySymbol` | string | Currency Symbol |\r\n| `timeZone` | string | Order Time Zone |\r\n| `totals` | object | Totals Object |\r\n| `id` | string | Totals Ids, expected values: \"Items\", \"Discounts\", \"Shipping\" and \"Tax\" |\r\n| `name` | string | Totals ID Description |\r\n| `value` | integer | Totals Value |\r\n| `value` | integer | Order Value |\r\n" operationId: GetOrder2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/orderId' - $ref: '#/components/parameters/reason' responses: '200': description: OK content: application/json: schema: title: '' type: object properties: emailTracked: type: string description: Email tracked. example: clark.kent@example.com approvedBy: type: string description: User that approved the order, in case of manual approval. example: alex@store.com cancelledBy: type: string description: User that canceled the order. example: alex@store.com cancelReason: type: string description: Reason for cancelation. example: Stock shortage. orderId: type: string description: Order ID. example: v5195004lux-01 sequence: type: string description: Sequence number. example: '502556' marketplaceOrderId: type: string description: ID of the order in the marketplace. example: ABC-v5195004lux-01 marketplaceServicesEndpoint: type: string description: Marketplace endpoint for post purchase communication. example: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: type: string description: Seller order ID. example: 00-v5195004lux-01 origin: type: string description: Origin. example: Marketplace affiliateId: type: string description: Three letter code identifying the marketplace where the order was placed. example: ABC salesChannel: type: string description: Sales channel. example: '1' merchantName: type: string description: Merchant name. example: luxstore status: type: string description: Status in the order workflow. example: invoiced statusDescription: type: string description: Status description which is displayed on the Admin panel. example: Faturado value: type: integer format: int32 description: Value in cents. example: 2499 creationDate: type: string description: Creation date. example: '2019-01-28T20:09:43+00:00' lastChange: type: string description: Date of last change. example: '2019-02-06T20:46:11.7010747+00:00' orderGroup: type: string description: Order group. example: '00' totals: type: array description: Information on each of the order's totals. items: type: object properties: id: type: string description: Order's total ID. example: Discounts name: type: string description: Order's total name. example: Discount total. value: type: integer format: int32 description: Order's total value. example: 199 items: type: array description: Information on each item in the order. items: type: object properties: uniqueId: type: string description: Order's item unique ID. id: type: string description: ID. productId: type: string description: Product ID. productRefId: type: string description: Product Ref ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. name: type: string description: Name. skuName: type: string description: SKU name. modalType: type: string description: Modal type. parentItemIndex: type: integer description: Parent item index. parentAssemblyBinding: type: string description: Parent assembly binding. priceValidUntil: type: string description: Price expiration date and time. tax: type: integer description: Tax value in cents. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. manualPrice: type: integer description: Manual price in cents. manualPriceAppliedBy: type: string description: User that applied the manual price, if that is the case. sellingPrice: type: integer description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead. rewardValue: type: integer description: Reward value in cents. isGift: type: boolean description: Indicates whether item is a gift. additionalInfo: type: object description: Additional information. properties: dimension: type: string description: Dimension. brandName: type: string description: Brand name. brandId: type: string description: Brand ID. offeringInfo: type: string description: Offering information. offeringType: type: string description: Offering type. offeringTypeId: type: string description: Offering type ID. preSaleDate: type: string description: Presale date. productCategoryIds: type: string description: Product category IDs. productCategories: type: object description: Object, where each field is an ID from `productCategoryIds. properties: '{ID}': type: string description: Product category corresponding to the ID in the field key. quantity: type: integer description: Quantity. seller: type: string description: Seller. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller. imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. bundleItems: type: array description: 'Information on services sold along with the SKU. Example: a gift package.' items: type: object properties: type: type: string description: Type id: type: integer description: Service identifier. name: type: string description: Name. price: type: integer description: Price in cents. attachments: type: array description: Array containing information on attachments. items: type: string priceTags: type: array description: Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. items: type: object properties: identifier: type: string description: Price tag identifier. isPercentual: type: boolean description: Indicates whether price tag value is applied through a percentage. name: type: string description: Name. rawValue: type: integer description: Raw value. value: type: integer description: Value. availability: type: string description: Availability measurementUnit: type: string description: Measurement unit unitMultiplier: type: integer description: Unit multiplier manufacturerCode: type: string description: Manufacturer code. priceDefinition: type: object description: Price information. properties: calculatedSellingPrice: type: integer description: Calculated selling price in cents. total: type: integer description: Total in cents. sellingPrices: type: array description: Selling prices. items: type: object properties: value: type: integer description: Value in cents. quantity: type: integer description: Quantity. marketplaceItems: type: array description: Marketplace items. items: type: string clientProfileData: $ref: '#/components/schemas/ClientProfileData' giftRegistryData: type: string nullable: true description: Gift registry data. marketingData: type: string nullable: true description: Marketing data. ratesAndBenefitsData: $ref: '#/components/schemas/RatesAndBenefitsData' shippingData: $ref: '#/components/schemas/ShippingData' paymentData: $ref: '#/components/schemas/PaymentData' packageAttachment: type: object description: Package attachment. properties: packages: type: array description: Information on each package. items: type: object properties: items: type: array description: Information on each item in the package. items: type: object properties: itemIndex: type: integer description: Item index in reference to the position of the item in the `items` array. quantity: type: integer description: Item quantity. price: type: integer description: Item price in cents. description: type: string description: Item description. unitMultiplier: type: number description: Item unit multiplier. courier: type: string description: Courier. invoiceNumber: type: string description: Invoice number. invoiceValue: type: integer description: Invoice value in cents. invoiceUrl: type: string description: Invoice URL. issuanceDate: type: string description: Issuance date. trackingNumber: type: string description: Tracking number. invoiceKey: type: string description: Invoice key. trackingUrl: type: string description: Tracking URL. embeddedInvoice: type: string description: Embedded voice in XML. type: type: string description: Invoice type `Output` for sales and `Input` for returns. courierStatus: type: string description: Courier status. cfop: type: string description: Fiscal operation code. restitutions: type: object description: Information on how restitutions are to be made to the customer, in case of a return (invoice `type` is `input`). properties: refund: type: object description: Information on refunds. properties: items: type: array description: Information on items. items: type: object properties: itemIndex: type: string description: Item index corresponding to the position of the item in the main `items` array. quantity: type: integer description: Quantity. volumes: type: integer description: Quantity of packages involved in the order. example: packages: [] sellers: type: array items: $ref: '#/components/schemas/Seller' description: Array with sellers information. callCenterOperatorData: type: string nullable: true description: Call center operator data. followUpEmail: type: string description: Follow up email. lastMessage: type: string nullable: true description: Last message. hostname: type: string description: Host name. invoiceData: type: object description: Information pertinent to the order's invoice. nullable: true changesAttachment: $ref: '#/components/schemas/ChangesAttachment' openTextField: type: string nullable: true description: Open text field. roundingError: type: integer format: int32 description: Rounding error in cents. orderFormId: type: string description: ID of the shopping cart from which the order was created. commercialConditionData: type: string nullable: true description: Commercial condition data. isCompleted: type: boolean description: Indicates whether order is completed. customData: type: string nullable: true description: Custom data. storePreferencesData: $ref: '#/components/schemas/StorePreferencesData' allowCancellation: type: boolean description: Indicates whether cancelation is allowed for the order. allowEdition: type: boolean description: Indicates whether edition is allowed for the order. isCheckedIn: type: boolean description: Indicates whether client is checked in. marketplace: $ref: '#/components/schemas/Marketplace' authorizedDate: type: string description: Date in which the order was authorized in UTC. invoicedDate: type: string description: Date in which the order was invoiced in UTC. example: emailTracked: a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br approvedBy: null cancelledBy: null cancelReason: null 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: null 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: null 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: null lockId: 00-v5195004lux-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: null 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: [] sellerSku: '1234568358' priceValidUntil: null commission: 0 tax: 0 preSaleDate: null 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: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: null rewardValue: 0 freightCommission: 0 priceDefinitions: null taxCode: null parentItemIndex: null parentAssemblyBinding: null marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null giftRegistryData: null marketingData: null ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' polygonName: null trackingHints: null selectedAddresses: - addressId: '-1425945657910' 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: null 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: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: {} packageAttachment: packages: [] sellers: - id: '1' name: Loja do Suporte logo: '' callCenterOperatorData: null followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: null hostname: luxstore invoiceData: null changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: null receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: null roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: null isCompleted: true customData: null 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: null name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: null example: emailTracked: a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br approvedBy: null cancelledBy: null cancelReason: null 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: null 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: null 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: null lockId: 00-v5195004lux-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: null 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: [] sellerSku: '1234568358' priceValidUntil: null commission: 0 tax: 0 preSaleDate: null 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: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: null rewardValue: 0 freightCommission: 0 priceDefinitions: null taxCode: null parentItemIndex: null parentAssemblyBinding: null marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null giftRegistryData: null marketingData: null ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' polygonName: null contactInformation: - id: '1' email: paTest@mailinator.com firstName: Postman lastName: Test document: 01675916306 phone: '+552222222222' documentType: cpf trackingHints: null selectedAddresses: - addressId: '-1425945657910' 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: null 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: null firstDigits: null lastDigits: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: {} packageAttachment: packages: [] sellers: - id: '1' name: Loja do Suporte logo: '' callCenterOperatorData: null followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: null hostname: luxstore invoiceData: null changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: null receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: null roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: null isCompleted: true customData: null 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: null name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: null deprecated: false /api/orders/extendsearch/orders: post: tags: - Orders summary: VTex List orders description: "Retrieves a list of orders according to the filters described below.\n\r\n\r> This endpoint returns masked order data.\n\r\n\r> This should **not** be used for integrations. Use the [orders Feed or hook](https://developers.vtex.com/vtex-rest-api/docs/feed-v3-1) for this purpose.\n\r\n\rThis endpoint returns only orders that already have been indexed, which takes aproximately 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/vtex-rest-api/docs/feed-v3-1).\n\r\n\r> 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.\n\r\n\r## Do not use request for integrations\n\r> This endpoint returns only orders that already have been indexed, which takes aproximately four minutes. Because of this, the data retrieved may present inconsistencies or become unavailable in periods of peak order volume. In other words, **order integrations built with the List orders endpoint are not reliable** and **will not be supported**. 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/vtex-rest-api/docs/feed-v3-1).\n\r\n\r## Throtling\n\rEach account can make up to 5000 requests per minute.\n\r\n\r## Request parameters allowed\n\r\n\r| Attribute | Type | Description |\r\n| --------------- |:---------:| -------------------------------------------------------------------------------------------:|\r\n| `orderBy` | string | Order Field and Order Type concatenated `orderBy={{OrderField}},{{OrderType}}` |\r\n| `OrderField` | string | Order Field expected values: `creationDate`,`orderId`,`items`,`totalValue` and `origin` |\r\n| `OrderType` | string | Order Type expected values: `asc` and `desc` |\r\n\r\n\r\n## Sorting Examples\r\n\r\n\r\nCreationDate:\r\n\r\n `/api/oms/pvt/orders?orderBy=creationDate,desc`\r\n\r\n\r\nOrderID:\r\n\r\n `/api/oms/pvt/orders?orderBy=orderId,desc`\r\n\r\n\r\nItems:\r\n\r\n `/api/oms/pvt/orders?orderBy=items,asc`\r\n\r\n\r\nTotalValue:\r\n\r\n `/api/oms/pvt/orders?orderBy=totalValue,desc`\r\n\r\n\r\nOrigin: \r\n\r\n `/api/oms/pvt/orders?orderBy=origin,asc`\r\n\r\n\r\n\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `page` | integer | Page Number |\r\n\r\n## Pagination Examples:\r\n\r\n `/api/oms/pvt/orders?page=3`\r\n\r\n\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `per_page` | integer | Quantity orders per page |\r\n\r\nQuantity per Page Examples:\r\n\r\n `/api/oms/pvt/orders?per_page=15`\r\n\r\n\r\n\r\n\r\n\r\n
Pagination Limit: The limit of pages that can be requested is 30.\r\n
\r\n\r\n\r\n\r\n## Time zone query \r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `utc` | integer | Time Zone. By including this parameter alone in your query, the call will not convert the UTC nor show the number of orders set for that UTC. To filter orders with the desired UTC, you must also modify date and time in the `f_creationDate=creationDate:` parameter. |\r\n\r\nTime Zone Example:\r\n\r\n `/api/oms/pvt/orders?utc=-0200`\r\n\r\n\r\n\r\n\r\n## Request filters \r\n\r\n\r\n## Fulltext\r\n\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `q` | string | Fulltext accepts Order Ids, Client E-mail, Client Document and Client Name |\r\n\r\n> The `+` caracter isn't allowed in Fulltext Search\r\n\r\n\r\nFulltext filter Examples:\r\n\r\nOrderID: \r\n \r\n `/api/oms/pvt/orders?q=v212333lux-02`\r\n\r\n\r\nEmail:\r\n \r\n `/api/oms/pvt/orders?q=rodrigo.cunha@vtex.com`\r\n\r\n\r\nDocument: \r\n \r\n `/api/oms/pvt/orders?q=21133355524`\r\n\r\n\r\nClientName:\r\n\r\n `/api/oms/pvt/orders?q=Cunha`\r\n\r\n\r\n\r\n\r\n## Shipping Estimate\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_shippingEstimate` | string | Concatened value of quantity days and sufix `.days` |\r\n\r\n\r\n\r\n\r\nShipping Estimate filter Examples:\r\n\r\n\r\nNext 7 days:\r\n\r\n `/api/oms/pvt/orders?f_shippingEstimate=7.days`\r\n\r\n\r\nTomorrow: \r\n\r\n `/api/oms/pvt/orders?f_shippingEstimate=1.days`\r\n\r\n\r\nToday:\r\n \r\n `/api/oms/pvt/orders?f_shippingEstimate=0.days`\r\n\r\n\r\nLate:\r\n \r\n `/api/oms/pvt/orders?f_shippingEstimate=-1.days`\r\n\r\n\r\n\r\n\r\n## Invoiced Date\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_invoicedDate` | string | Concatened value sufix `invoicedDate` and range date in Timestamp format |\r\n\r\n\r\n\r\nInvoiced Date filter Examples:\r\n\r\n1 Day: \r\n\r\n `/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`\r\n\r\n\r\n1 Month: \r\n \r\n `/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`\r\n\r\n\r\n1 Year:\r\n\r\n `/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`\r\n\r\n\r\n\r\n## Order Date\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_creationDate` | string | Concatened value suffix `creationDate` and range date in Timestamp format |\r\n\r\n\r\n\r\nOrder Date filter Examples:\r\n\r\n1 Day:\r\n\r\n `/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`\r\n\r\n\r\n1 Month:\r\n\r\n `/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`\r\n\r\n\r\n1 Year:\r\n\r\n `/api/oms/pvt/orders?f_creationDate=creationDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`\r\n\r\n\r\n\r\n\r\n## Authorized Date\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_authorizedDate` | string | Concatened value suffix `authorizedDate` and range date in Timestamp format |\r\n\r\n\r\n\r\nAuthorized Date filter Examples:\r\n\r\n1 Day:\r\n\r\n `/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`\r\n\r\n\r\n1 Month:\r\n\r\n `/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`\r\n\r\n\r\n1 Year:\r\n\r\n `/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`\r\n\r\n\r\n\r\n\r\n## UTMs\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_UtmSource` | string | UTM Source value |\r\n\r\n\r\n\r\nChannels filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_UtmSource=buscape_campaign`\r\n\r\n\r\n\r\n\r\n## Seller\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_sellerNames` | string | Seller Name value |\r\n\r\n\r\n\r\nSeller filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_sellerNames=Fast+Shop`\r\n\r\n\r\n\r\n\r\n## Call Center Operator\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_callCenterOperatorName` | string | Call Center Operator Value |\r\n\r\n\r\n\r\nCall Center Operator filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_callCenterOperatorName=Operator%20Name`\r\n\r\n\r\n\r\n\r\n## Sales Channel Name\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_salesChannel` | string | Sales Channel Name Value |\r\n\r\n\r\n\r\nSales Channel Name filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_salesChannel=Main`\r\n\r\n\r\n\r\n\r\n\r\n## Sales Channel ID\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `salesChannelId` | string | Sales Channel ID Value |\r\n\r\n\r\n\r\nSales Channel ID filter Examples:\r\n\r\n `/api/oms/pvt/orders?salesChannelId=1`\r\n\r\n\r\n\r\n\r\n\r\n## Affiliate ID\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_affiliateId` | string | Affiliate ID Value |\r\n\r\n\r\n\r\nAffiliate ID filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_affiliateId=WLM`\r\n\r\n\r\n\r\n\r\n## Order Status \r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_status` | string | Order Status Value |\r\n\r\n\r\n\r\n| Order Status avaible to filter |\r\n| --------------------- |\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` | \r\n\r\n\r\nOrder Status filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_status=ready-for-handling`\r\n\r\n\r\n\r\n\r\n## Order Status Description\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_statusDescription` | string | Order Status Description Value |\r\n\r\n\r\n\r\n\r\n\r\n| Order Status Description avaible to filter |\r\n| --------------------- |\r\n| `Aguardando+autorização+para+despachar` | \r\n| `Pagamento+Pendente` | \r\n| `Pagamento+Aprovado` | \r\n| `Pronto+para+o+manuseio` | \r\n| `Preparando+Entrega` | \r\n| `Faturado` | \r\n| `Cancelado` | \r\n\r\nOrder Status Description filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_statusDescription=Pronto+para+o+manuseio`\r\n\r\n\r\n\r\n\r\n\r\n## Order Situation\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `incompleteOrders` | boolean | If is a Incomplete Order |\r\n\r\n\r\n> know more about [Incomplete Orders in VTEX Help](https://help.vtex.com/en/tutorial/understanding-incomplete-orders)\r\n\r\nOrder Situation filter Examples:\r\n\r\n `/api/oms/pvt/orders?incompleteOrders=true`\r\n\r\n\r\n\r\n\r\n\r\n## Error Situation\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `incompleteOrders` | boolean | Error Situation Type |\r\n\r\n\r\n\r\n| Error Situation Values avaible to filter |\r\n| ------- |\r\n| `all` | \r\n| `perm` | \r\n| `temp` | \r\n\r\n\r\nError Situation filter Examples:\r\n\r\n `/api/oms/pvt/orders?filterError=all`\r\n\r\n\r\n\r\n\r\n\r\n\r\n## Payment Type Name\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_paymentNames` | string | Payment Type Value |\r\n\r\n\r\n\r\nPayment Type Name filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_paymentNames=Visa`\r\n\r\n\r\n\r\n\r\n\r\n## Rates and Benefits Name\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `f_RnB` | string | Rates and Benefits Name |\r\n\r\n\r\n\r\nRates and Benefits filter Examples:\r\n\r\n `/api/oms/pvt/orders?f_RnB=\"Free+Shipping\"`\r\n\r\n\r\n\r\n\r\n## Search Field\r\n\r\n| Attribute | Type | Description |\r\n| ------------ |:---------:| -----------:|\r\n| `searchField` | string | Affiliate ID Value |\r\n| `sku_Ids&sku_Ids` | integer | SKU ID |\r\n| `listId&listId` | integer | Gift List ID |\r\n| `tid&tid` | integer | Transaction ID (TID) |\r\n| `pci_tid&pci_tid` | integer | PCI Connector's Transaction ID (TID) |\r\n| `paymentId&paymentId` | integer | Payment ID (PID) |\r\n| `nsu&nsu` | integer | Connector's NSU |\r\n\r\n\r\n\r\nSearch Field filter Examples:\r\n\r\nSKU ID:\r\n \r\n `/api/oms/pvt/orders?searchField=sku_Ids&sku_Ids=11223`\r\n\r\n\r\n\r\nGift List ID:\r\n \r\n `/api/oms/pvt/orders?searchField=listId&listId=11223`\r\n\r\n\r\n \r\nTransaction ID (TID):\r\n \r\n `/api/oms/pvt/orders?searchField=tid&tid=54546300238810034995829230012`\r\n\r\n\r\n \r\nPCI Connector's Transaction ID (TID):\r\n\r\n `/api/oms/pvt/orders?searchField=pci_tid&pci_tid=7032909234899834298423209`\r\n\r\n\r\n \r\nPayment ID (PID):\r\n \r\n `/api/oms/pvt/orders?searchField=paymentId&paymentId=2`\r\n\r\n\r\n \r\nConnector's NSU:\r\n \r\n `/api/oms/pvt/orders?searchField=nsu&nsu=2437281`\r\n\\n\\r\\n\\r## Response objects\\n\\r\\n\\r,\r\n**Response object has the following properties:**\r\n\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `list` | object | Order List Object |\r\n| `shippingEstimateDate` | string | Estimate Shipping Date |\r\n| `affiliateId` | string | Seller Name who was responsible for the order |\r\n| `authorizedDate` | string | Authorized Order Date |\r\n| `callCenterOperatorData` | string | Call Center Operator responsible for the order |\r\n| `name` | string | Client Name|\r\n| `creationDate` | string | Order Creation Date |\r\n| `currencyCode` | string | Currency Code in ISO 4217 |\r\n| `items` | object | Obsolete Field |\r\n| `lastMessageUnread` | string | Last sent transactional message |\r\n| `listId` | string | Releated Gift List Id |\r\n| `listType` | string | Releated Gift List Type |\r\n| `marketplaceOrderId` | string | Marketplace Order Id |\r\n| `orderId` | string | Change receipt order Id |\r\n| `orderIsComplete` | boolean | If is a Order Completed |\r\n| `origin` | string | Order Origin: \"Marketplace\" or \"Fulfillment\" |\r\n| `paymentNames` | string | Payment System Name |\r\n| `salesChannel` | string | Order Sales Channel Id |\r\n| `sequence` | string | Order Sequence ID |\r\n| `status` | string | Order Status |\r\n| `statusDescription` | string | Status Description |\r\n| `totalItems` | integer | Total Order Items |\r\n| `totalValue` | integer | Total Value Amount |\r\n| `workflowInErrorState` | boolean | If is a Work Flow Error |\r\n| `workflowInRetry` | boolean | If is in a Work Flow Retry |\r\n| `paging` | object | Paging Details Object |\r\n| `pages` | integer | Paging Total Pages |\r\n| `perPage` | integer | Paging total per Page |\r\n| `total` | integer | Total Result |\r\n| `stats` | object | Results segmented by `totalItems` and `totalValue` |\r\n| `totalItems` | integer | Total Order Items segmeted by `currencyCode` and `origin`|\r\n| `totalValue` | integer | Total Value Amount segmeted by `currencyCode` and `origin`|\r\n| `currencyCode` | string | Currency Code in ISO 4217 |\r\n| `origin` | string | Order Origin: \"Marketplace\" or \"Fulfillment\" |\r\n| `Count` | integer | Orders Count |\r\n| `Facets` | object | Grouping Object |\r\n| `Max` | object | Paging Details Object |\r\n| `Mean` | object | Paging Details Object |\r\n| `Min` | object | Paging Details Object |\r\n| `Missing` | object | Paging Details Object |\r\n| `StdDev` | object | Paging Details Object |\r\n| `Sum` | object | Paging Details Object |\r\n| `SumOfSquares` | object | Paging Details Object |" operationId: ListOrders2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/f_hasInputInvoice' requestBody: content: application/json: schema: type: object required: - f_creationDate - per_page - page properties: f_creationDate: type: string description: Concatened value sufix {{creationDate}} and range date in Timestamp format. example: creationDate:[2021-11-01T00:00:00.000Z TO 2022-11-10T02:00:00.000Z] per_page: type: integer description: Number of orders per page. example: 15 page: type: integer description: Number of the page to be retrieved. example: 1 q: type: string description: Full-text search for the orders. example: Postman Test 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_2' example: list: - orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: null totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: null totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null deprecated: false /api/orders/pvt/document/{orderId}/actions/start-handling: post: tags: - Orders summary: VTex Start handling order description: "Change the status of an order to indicate that is is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request.\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: StartHandling2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/orderId' responses: '204': description: No content '403': description: Forbidden '404': description: Not found '429': description: Too many requests deprecated: false /api/orders/pvt/document/{orderId}/cancel: post: tags: - Orders summary: VTex Cancel order description: "You should use this endpoint to cancel an order by its `orderId`.\n\nA common scenario is one where the seller has a problem with the order fulfillment and needs to request the order cancellation to the marketplace. To do this, the seller would need to make this request, passing the `orderId` in the URL.\n\nYou should expect a response with the date when the notification was received, the orderId, and a receipt protocol code.\n\nBe aware that if the order status is already `Invoiced`, the order can only be canceled if - before using this request - you send a return invoice through the [Order Invoice Notification endpoint](https://developers.vtex.com/reference/invoice#invoicenotification).\n\r\n\r> The `Cancel order` 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: CancelOrder2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/orderId' 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 components: schemas: 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null ChangesAttachment: title: ChangesAttachment required: - id - changesData type: object properties: id: type: string description: Change ID. changesData: type: array items: $ref: '#/components/schemas/ChangesDatum' description: Array with data on order changes. example: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: null receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null 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: null 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. 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null Transaction: title: Transaction required: - isActive - transactionId - merchantName - payments type: object properties: isActive: type: boolean description: Indicates whether transaction is active. transactionId: type: string description: Transaction ID. merchantName: type: string description: Merchant name. payments: type: array items: $ref: '#/components/schemas/Payment' description: Array with information on each payment for the order. example: isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: {} 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: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null ItemsRemoved: title: ItemsRemoved required: - id - name - quantity - price - unitMultiplier type: object properties: id: type: string description: Id of removed item. name: type: string description: Name of removed item. quantity: type: integer format: int32 description: Quantity of items removed. price: type: integer format: int32 description: Removed items price in cents. unitMultiplier: type: string nullable: true description: Removed item unit multiplier. example: id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: null 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: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null 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: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL List_2: 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 description: Order ID. creationDate: type: string description: Creation date. clientName: type: string description: Client name. items: type: string nullable: true description: Order items. totalValue: type: integer format: int32 description: Order total value in cents. paymentNames: type: string description: Order payment names. status: type: string description: Order status. statusDescription: type: string description: Order status description. marketPlaceOrderId: type: string nullable: true description: ID of the order in the marketplace. sequence: type: string description: Order sequence number. salesChannel: type: string description: Sales channel. affiliateId: type: string description: Three letter code indicating the marketplace in which the order was placed. origin: type: string description: Indicates whether order is marketplace, fulfillment or chain. workflowInErrorState: type: boolean description: Indicates whether order workflow is in error state. workflowInRetry: type: boolean description: Indicates whether workflow is in retry. lastMessageUnread: type: string nullable: true description: Last unread message. ShippingEstimatedDate: type: string nullable: true description: Shipping estimate date. ShippingEstimatedDateMax: type: string nullable: true description: Maximum shipping estimate date. ShippingEstimatedDateMin: type: string nullable: true description: Minimum shipping estimate date. orderIsComplete: type: boolean description: Indicates whether order is complete. listId: type: string nullable: true description: List ID. listType: type: string nullable: true description: List type. authorizedDate: type: string nullable: true description: Authorized date. callCenterOperatorName: type: string nullable: true description: Call center operator name. totalItems: type: integer format: int32 description: Total items. currencyCode: type: string description: Currency code. example: orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null RatesAndBenefitsData: title: RatesAndBenefitsData required: - id - rateAndBenefitsIdentifiers type: object properties: id: type: string description: Field ID. default: ratesAndBenefitsData rateAndBenefitsIdentifiers: type: array items: type: string description: Array with rates and benefits IDs. example: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] Marketplace: title: Marketplace required: - baseURL - isCertified - name type: object properties: baseURL: type: string description: Marketplace base URL. isCertified: type: string nullable: true description: Indicates whether marketplace is certified. name: type: string description: Marketplace name. example: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: null name: luxstore Receipt: title: Receipt required: - date - orderId - receipt type: object properties: date: type: string description: Date. orderId: type: string description: Order ID. receipt: type: string description: Receipt. example: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b 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 Address: title: Address required: - addressType - receiverName - addressId - postalCode - city - state - country - street - number - neighborhood - complement - reference - geoCoordinates type: object properties: addressType: type: string description: Address type. receiverName: type: string description: Address receiver name. addressId: type: string description: Address ID. postalCode: type: string description: Address postal code. city: type: string description: Address city. state: type: string description: Address state. country: type: string description: Address country. street: type: string description: Address street. number: type: string description: Address number. neighborhood: type: string description: Address neighborhood. complement: type: string description: Address complement. reference: type: string nullable: true description: Address reference. geoCoordinates: type: array items: type: string description: Geolocation coordinates. contactId: type: string description: Contact unique identifier. example: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] contactId: '1' PickupStoreInfo: title: PickupStoreInfo required: - additionalInfo - address - dockId - friendlyName - isPickupStore type: object properties: additionalInfo: type: string nullable: true description: Pickup additional information. address: type: string nullable: true description: Pickup address. dockId: type: string nullable: true description: Pickup dock ID. friendlyName: type: string nullable: true description: Pickup friendly name. isPickupStore: type: boolean description: Indicates whether it is pickup store. example: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null PaymentData: title: PaymentData required: - transactions type: object properties: transactions: type: array items: $ref: '#/components/schemas/Transaction' description: Array with information on each transaction of the order. example: transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: {} Seller: title: Seller required: - id - name - logo type: object properties: id: type: string description: Seller ID. name: type: string description: Seller name. logo: type: string description: Seller logo. example: id: '1' name: Loja do Suporte logo: '' AddLogRequest: title: AddLogRequest required: - source - message type: object properties: source: type: string message: type: string example: source: Postman message: Teste add interactions 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: null DeliveryId: title: DeliveryId required: - courierId - courierName - dockId - quantity - warehouseId type: object properties: courierId: type: string description: Courier ID. courierName: type: string description: Courier name. dockId: type: string description: Dock ID. quantity: type: integer format: int32 description: Quantity. warehouseId: type: string description: Warehouse ID. example: courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' StorePreferencesData: title: StorePreferencesData required: - countryCode - currencyCode - currencyFormatInfo - currencyLocale - currencySymbol - timeZone type: object properties: countryCode: type: string description: Three letter ISO country code. currencyCode: type: string description: Currency code. currencyFormatInfo: $ref: '#/components/schemas/CurrencyFormatInfo' currencyLocale: type: integer format: int32 description: Currency locale. currencySymbol: type: string description: Currency symbol. timeZone: type: string description: Time zone. example: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time 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: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: null totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: null totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null 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: null ClientProfileData: title: ClientProfileData required: - id - email - firstName - lastName - documentType - document - phone - corporateName - tradeName - corporateDocument - stateInscription - corporatePhone - isCorporate - userProfileId - customerClass type: object properties: id: type: string description: Client ID. email: type: string description: Client email address. firstName: type: string description: Client first name. lastName: type: string description: Client last name. documentType: type: string description: Client document type. document: type: string description: Client document. phone: type: string description: Client telephone number. corporateName: type: string nullable: true description: Company name, in case client is corporate. tradeName: type: string nullable: true description: Company trade name, in case client is corporate. corporateDocument: type: string nullable: true description: Company document, in case client is corporate. stateInscription: type: string nullable: true description: Company state inscription, in case client is corporate. corporatePhone: type: string nullable: true description: Company telephone number, in case client is corporate. isCorporate: type: boolean description: Indicates whether client is corporate. userProfileId: type: string description: User profile ID. customerClass: type: string nullable: true description: Customer class. example: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null Paging_2: title: Paging required: - total - pages - currentPage - perPage type: object properties: total: type: integer format: int32 description: Paging total. pages: type: integer format: int32 description: Number of pages. currentPage: type: integer format: int32 description: Current returned page. perPage: type: integer format: int32 description: Number of items returned per page. example: total: 84 pages: 6 currentPage: 1 perPage: 15 CurrencyFormatInfo: title: CurrencyFormatInfo required: - CurrencyDecimalDigits - CurrencyDecimalSeparator - CurrencyGroupSeparator - CurrencyGroupSize - StartsWithCurrencySymbol type: object properties: CurrencyDecimalDigits: type: integer format: int32 description: Currency decimal digits. CurrencyDecimalSeparator: type: string description: Currency decimal separator. CurrencyGroupSeparator: type: string description: Currency group separator. CurrencyGroupSize: type: integer format: int32 description: Currency group size. StartsWithCurrencySymbol: type: boolean description: Indicates whether value representations start with currency symbol. example: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true 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 ChangesDatum: title: ChangesDatum required: - reason - discountValue - incrementValue - itemsAdded - itemsRemoved - receipt type: object properties: reason: type: string description: Change reason. discountValue: type: integer format: int32 description: Discount value in cents. incrementValue: type: integer format: int32 description: Order value increment in cents. itemsAdded: type: array items: type: string description: Array with information on items added to the order. itemsRemoved: type: array items: $ref: '#/components/schemas/ItemsRemoved' description: Array with information on 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: null receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b SelectedAddress: $ref: '#/components/schemas/Address' LogisticsInfo: title: LogisticsInfo required: - itemIndex - selectedSla - lockTTL - price - listPrice - sellingPrice - deliveryWindow - deliveryCompany - shippingEstimate - shippingEstimateDate - slas - shipsTo - deliveryIds - deliveryChannel - pickupStoreInfo - addressId - polygonName type: object properties: itemIndex: type: integer format: int32 description: Item index, matching the index in the `items` array. selectedSla: type: string description: Selected SLA. lockTTL: type: string description: Reservation lasting period. price: type: integer format: int32 description: Prince in cents. listPrice: type: integer format: int32 description: List price in cents. sellingPrice: type: integer format: int32 description: Selling price in cents. deliveryWindow: type: string nullable: true description: Delivery window information. deliveryCompany: type: string description: Delivery company. shippingEstimate: type: string description: Shipping estimate. shippingEstimateDate: type: string description: Shipping estimate date. slas: type: array items: $ref: '#/components/schemas/Sla' description: Array with information on the SLAs. shipsTo: type: array items: type: string description: List of countries (three letter ISO code) to which shipping is available. deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryId' description: Array of delivery IDs. deliveryChannel: type: string description: Delivery channel. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' addressId: type: string description: Address ID. polygonName: type: string nullable: true description: Polygon name. example: itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' polygonName: null Sla: title: Sla required: - id - name - shippingEstimate - deliveryWindow - price - deliveryChannel - pickupStoreInfo - polygonName type: object properties: id: type: string description: SLA ID. name: type: string description: SLA name. shippingEstimate: type: string description: SLA shipping estimate. deliveryWindow: type: string nullable: true description: SLA delivery window. price: type: integer format: int32 description: SLA price in cents. deliveryChannel: type: string description: SLA delivery channel. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' polygonName: type: string nullable: true description: SLA polygon name. example: id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null 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: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null ListOrders_2: title: ListOrders required: - list - facets - paging - stats type: object properties: list: type: array items: $ref: '#/components/schemas/List_2' description: Array containing information on orders listed. facets: type: array items: type: string description: Array of facets. paging: $ref: '#/components/schemas/Paging_2' stats: $ref: '#/components/schemas/Stats' example: list: - orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: null totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: null totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: null totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: null totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: null 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: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: null totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: null totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: null 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: null ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: null 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: null Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: null currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: null 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: null Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: null currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: null Payment: title: Payment 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. paymentSystemName: type: string description: Payment system name. value: type: integer format: int32 description: Payment value in cents. installments: type: integer format: int32 description: Payment installments. referenceValue: type: integer format: int32 description: Reference value for interest calculation in cents. cardHolder: type: string nullable: true description: Card holder 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 code. expireMonth: type: string nullable: true description: Card expiration month. expireYear: type: string nullable: true description: Card expiration year. url: type: string 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: Redemption code. group: type: string description: Payment group. tid: type: string nullable: true description: Payment TID. dueDate: type: string description: Due date. connectorResponses: type: object description: Connector responses. example: id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: {} ShippingData: title: ShippingData required: - id - address - logisticsInfo - trackingHints - selectedAddresses type: object properties: id: type: string description: Field ID. default: shippingData address: $ref: '#/components/schemas/Address' logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfo' description: Array with logistics information of each item in the order. contactInformation: type: array description: Array with contact information. items: type: object description: Contact information. properties: id: type: string description: Contact unique identifier. email: type: string description: Contact email. firstName: type: string description: Contact first name. lastName: type: string description: Contact last name. document: type: string description: Contact document number. phone: type: string description: Contact phone number. documentType: type: string description: Contact document type. trackingHints: type: string nullable: true description: Tracking hints. selectedAddresses: type: array items: $ref: '#/components/schemas/SelectedAddress' description: Array of the selected addresses' information. example: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' polygonName: null contactInformation: - id: '1' email: paTest@mailinator.com firstName: Postman lastName: Test document: 01675916306 phone: '+552222222222' documentType: cpf trackingHints: null selectedAddresses: - addressId: '-1425945657910' 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: null geoCoordinates: [] parameters: Accept: name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string example: application/json f_hasInputInvoice: 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 default: false Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string example: application/json reason: name: reason in: query description: Reason for requesting unmasked data. required: false style: form schema: type: string example: data-validation orderId: name: orderId in: path description: ID of the order. required: true style: simple schema: type: string example: 70caf3941s6df1 securitySchemes: VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'