openapi: 3.0.0 info: title: VTex Orders API - PII data architecture description: "\r\n\r\n>⚠️ The **Orders API - PII data architecture** is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\nStores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus) must use this adapted version of the Orders API.\r\n\r\nLearn more about the modified behavior at [Changes in VTEX features behavior to handle PII data](https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data).\r\n## Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#get-/api/orders/pvt/document/-orderId-)\r\n- `POST` [List orders](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/extendsearch/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/actions/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/cancel)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/invoices)\r\n\r\n### Payment\r\n\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/payment/-paymentId-/notify-payment)" contact: {} version: '1.0' servers: - url: https://{accountName}.{environment}.com.br description: VTEX server URL. variables: accountName: description: Name of the VTEX account. Used as part of the URL. default: apiexamples environment: description: Environment to use. Used as part of the URL. enum: - vtexcommercestable default: vtexcommercestable paths: /api/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: cancelledBy: cancelReason: orderId: v5195004lux-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v5195004lux-01 origin: Marketplace affiliateId: '' salesChannel: '1' merchantName: status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: lockId: 00-v5195004lux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: taxCode: parentItemIndex: parentAssemblyBinding: marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: giftRegistryData: marketingData: 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: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' polygonName: trackingHints: 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: geoCoordinates: [] paymentData: transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: {} packageAttachment: packages: [] sellers: - id: '1' name: Loja do Suporte logo: '' callCenterOperatorData: followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: hostname: luxstore invoiceData: changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: isCompleted: true customData: storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: false allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: example: emailTracked: a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br approvedBy: cancelledBy: cancelReason: orderId: v5195004lux-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v5195004lux-01 origin: Marketplace affiliateId: '' salesChannel: '1' merchantName: status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: lockId: 00-v5195004lux-01 itemAttachment: content: {} name: attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] sellerSku: '1234568358' priceValidUntil: commission: 0 tax: 0 preSaleDate: additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: offeringType: offeringTypeId: measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: rewardValue: 0 freightCommission: 0 priceDefinitions: taxCode: parentItemIndex: parentAssemblyBinding: marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: giftRegistryData: marketingData: 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: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' polygonName: contactInformation: - id: '1' email: paTest@mailinator.com firstName: Postman lastName: Test document: '01675916306' phone: '+552222222222' documentType: cpf trackingHints: 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: 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: firstDigits: lastDigits: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: {} packageAttachment: packages: [] sellers: - id: '1' name: Loja do Suporte logo: '' callCenterOperatorData: followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: hostname: luxstore invoiceData: changesAttachment: id: changeAttachment changesData: - reason: Blah discountValue: 3290 incrementValue: 0 itemsAdded: [] itemsRemoved: - id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b openTextField: roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: isCompleted: true customData: storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: false allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: 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' example: list: - orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502554' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide' ShippingEstimatedDate: '2019-01-31T12:36:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502551' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:40:55+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502548' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:35:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502544' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502541' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2018-12-19T18:22:26+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880102018018-01 sequence: '502537' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'cancelamento teste shp ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880091058221-01 sequence: '502535' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'Teste de cancelamento do ShopFácil ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 880090643370-01 sequence: '502534' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 876733475998-01 sequence: '502531' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL facets: [] paging: total: 84 pages: 6 currentPage: 1 perPage: 15 stats: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: 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 /api/orders/pvt/document/{orderId}/invoices: post: tags: - Invoice summary: VTex Order invoice notification description: "Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace.\n\nWe strongly recommend that you always send the object of the invoiced items. With this practice, rounding errors will be avoided.\n\nIt is not allowed to use the same `invoiceNumber` in more than one request to the Order Invoice Notification endpoint.\n\nBe aware that this endpoint is also used by the seller to send the order tracking information. This, however, should be done in a separate moment, once the seller has the tracking information.\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#)." operationId: InvoiceNotification2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/orderId' requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoiceNotificationRequest' example: type: Output issuanceDate: '2010-01-31' invoiceNumber: '9999' invoiceValue: '10000' invoiceKey: invoiceUrl: courier: trackingNumber: trackingUrl: dispatchedDate: items: - id: '1234' price: 10000 quantity: 1 required: true responses: '200': description: OK content: application/json: schema: type: object properties: date: type: string description: Date and time when the notification was received. orderId: type: string description: Identification of the order in the seller. receipt: type: string description: Protocol code generated by the update. It may be `null`. example: date: '2014-02-07T15:22:56.7612218-02:00' orderId: '123543123' receipt: 38e0e47da2934847b489216d208cfd91 '403': description: Forbidden '404': description: Not found '429': description: Too many requests deprecated: false /api/orders/pvt/document/{orderId}/payment/{paymentId}/notify-payment: post: tags: - Payment summary: VTex Send payment notification description: "Send a payment notification of a given order, by order ID and payment ID.\n\r\n\r> The `Notify payment` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).\n\r\n\r> Learn more about [Transaction Details](https://help.vtex.com/en/tutorial/how-to-view-the-orders-details).\r\n\r\n\r\n## Request body properties\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `orderId` | string | Order Id |\r\n| `paymentId` | string | Payment ID |" operationId: SendPaymentNotification2 parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/orderId' - $ref: '#/components/parameters/paymentId' responses: '200': description: OK '400': description: Bad Request '403': description: Forbidden '404': description: Not Found '429': description: Too Many Requests deprecated: false security: - appKey: - '{{appKey}}' appToken: - '{{appToken}}' components: securitySchemes: appKey: type: apiKey in: header name: X-VTEX-API-AppKey appToken: type: apiKey in: header name: X-VTEX-API-AppToken VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie schemas: 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: tradeName: corporateDocument: stateInscription: corporatePhone: isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: 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: [] 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: geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' polygonName: contactInformation: - id: '1' email: paTest@mailinator.com firstName: Postman lastName: Test document: '01675916306' phone: '+552222222222' documentType: cpf trackingHints: 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: geoCoordinates: [] 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: geoCoordinates: [] contactId: '1' 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: deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false addressId: '-1425945657910' polygonName: 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: price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: address: dockId: friendlyName: isPickupStore: false polygonName: 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: address: dockId: friendlyName: isPickupStore: false 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' SelectedAddress: $ref: '#/components/schemas/Address' 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: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: {} 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: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: {} 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: cardNumber: firstDigits: lastDigits: cvv2: expireMonth: expireYear: url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: giftCardName: giftCardCaption: redemptionCode: group: bankInvoice tid: dueDate: '2019-02-02' connectorResponses: {} 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: '' 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: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b ChangesDatum: title: ChangesDatum required: - reason - discountValue - incrementValue - itemsAdded - itemsRemoved - receipt type: object properties: reason: type: string description: 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: receipt: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b ItemsRemoved: title: ItemsRemoved required: - id - name - quantity - price - unitMultiplier type: object properties: id: type: string description: 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: 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 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 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 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: name: luxstore ListOrders: title: ListOrders required: - list - facets - paging - stats type: object properties: list: type: array items: $ref: '#/components/schemas/List' description: Array containing information on orders listed. facets: type: array items: type: string description: Array of facets. paging: $ref: '#/components/schemas/Paging' stats: $ref: '#/components/schemas/Stats' example: list: - orderId: v502559llux-01 creationDate: '2019-02-04T10:29:11+00:00' clientName: J C items: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Rodrigo VTEX items: totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502553llux-01 creationDate: '2019-01-24T12:35:19+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502554' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide' ShippingEstimatedDate: '2019-01-31T12:36:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-24T12:36:01+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502550llux-01 creationDate: '2019-01-23T16:39:45+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502551' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:40:55+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:40:27+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502547llux-01 creationDate: '2019-01-23T16:34:20+00:00' clientName: test test items: totalValue: 10150 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502548' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2019-01-30T16:35:30+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-01-23T16:35:04+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502544llux-01 creationDate: '2018-12-28T18:15:28+00:00' clientName: test test items: totalValue: 8990 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502544' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502541llux-01 creationDate: '2018-12-18T18:48:17+00:00' clientName: Douglas Rodrigues items: totalValue: 3290 paymentNames: Boleto Bancário status: canceled statusDescription: Cancelado marketPlaceOrderId: sequence: '502541' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: v502538llux-01 creationDate: '2018-12-12T18:21:47+00:00' clientName: test test items: totalValue: 8990 paymentNames: Mastercard status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: sequence: '502538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc' ShippingEstimatedDate: '2018-12-19T18:22:26+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-12-12T18:22:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880102018018-01 creationDate: '2018-11-30T17:34:01+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880102018018-01 sequence: '502537' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'cancelamento teste shp ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:34:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091692043-01 creationDate: '2018-11-30T17:28:35+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: invoiced statusDescription: Faturado marketPlaceOrderId: 880091692043-01 sequence: '502536' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:29:22+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880091058221-01 creationDate: '2018-11-30T17:18:00+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880091058221-01 sequence: '502535' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: 'Teste de cancelamento do ShopFácil ' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:18:44+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090643370-01 creationDate: '2018-11-30T17:10:59+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 880090643370-01 sequence: '502534' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-12-07T17:11:39+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-30T17:11:42+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-880090622238-01 creationDate: '2018-11-30T17:10:45+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 880090622238-01 sequence: '502533' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: MNC-877730530419-01 creationDate: '2018-11-20T21:09:01+00:00' clientName: Carlos VTEX items: totalValue: 11150 paymentNames: '' status: canceled statusDescription: Cancelado marketPlaceOrderId: 877730530419-01 sequence: '502532' salesChannel: '1' affiliateId: MNC origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-20T21:13:06+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL - orderId: SCP-876733475998-01 creationDate: '2018-11-16T16:58:18+00:00' clientName: roberta grecco items: totalValue: 1250 paymentNames: '' status: ready-for-handling statusDescription: Pronto para o manuseio marketPlaceOrderId: 876733475998-01 sequence: '502531' salesChannel: '1' affiliateId: SCP origin: Fulfillment workflowInErrorState: false workflowInRetry: false lastMessageUnread: ShippingEstimatedDate: '2018-11-23T16:58:48+00:00' ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2018-11-16T16:58:53+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL facets: [] paging: total: 84 pages: 6 currentPage: 1 perPage: 15 stats: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: List: title: List required: - orderId - creationDate - clientName - items - totalValue - paymentNames - status - statusDescription - marketPlaceOrderId - sequence - salesChannel - affiliateId - origin - workflowInErrorState - workflowInRetry - lastMessageUnread - ShippingEstimatedDate - ShippingEstimatedDateMax - ShippingEstimatedDateMin - orderIsComplete - listId - listType - authorizedDate - callCenterOperatorName - totalItems - currencyCode type: object properties: orderId: type: string 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: totalValue: 7453 paymentNames: Boleto Bancário status: invoiced statusDescription: Faturado marketPlaceOrderId: sequence: '502559' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci' ShippingEstimatedDate: ShippingEstimatedDateMax: ShippingEstimatedDateMin: orderIsComplete: true listId: listType: authorizedDate: '2019-02-07T21:29:54+00:00' callCenterOperatorName: totalItems: 1 currencyCode: BRL Paging: title: Paging required: - total - pages - currentPage - perPage type: object properties: total: type: integer 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 Stats: title: Stats required: - stats type: object properties: stats: $ref: '#/components/schemas/Stats1' example: stats: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Stats1: title: Stats1 required: - totalValue - totalItems type: object properties: totalValue: $ref: '#/components/schemas/TotalValue' totalItems: $ref: '#/components/schemas/TotalItems' example: totalValue: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: totalItems: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: TotalValue: title: TotalValue required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Value count. Max: type: integer format: int32 description: Value maximum. Mean: type: number description: Value mean. Min: type: integer format: int32 description: Value minimum. Missing: type: integer format: int32 description: Missing values. StdDev: type: number description: Values standard deviation. Sum: type: integer format: int32 description: Values sum. SumOfSquares: type: integer format: int64 description: Values sum of squares Facets: $ref: '#/components/schemas/Facets' example: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: Facets: title: Facets required: - origin - currencyCode type: object properties: origin: $ref: '#/components/schemas/Origin' currencyCode: $ref: '#/components/schemas/CurrencyCode' example: origin: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: currencyCode: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: Origin: title: Origin required: - Fulfillment - Marketplace type: object properties: Fulfillment: $ref: '#/components/schemas/Fulfillment' Marketplace: $ref: '#/components/schemas/Marketplace1' example: Fulfillment: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: Fulfillment: title: Fulfillment required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int32 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 68 Max: 11150 Mean: 1395.5882352941176 Min: 1250 Missing: 0 StdDev: 1200.5513439298484 Sum: 94900 SumOfSquares: 229010000 Facets: Marketplace1: title: Marketplace1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 16 Max: 21526180 Mean: 1373100.6875 Min: 1160 Missing: 0 StdDev: 5374326.141087491 Sum: 21969611 SumOfSquares: 463417210029853 Facets: CurrencyCode: title: CurrencyCode required: - BRL type: object properties: BRL: $ref: '#/components/schemas/BRL' example: BRL: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: BRL: title: BRL required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 84 Max: 21526180 Mean: 262672.75 Min: 1160 Missing: 0 StdDev: 2348087.3869179883 Sum: 22064511 SumOfSquares: 463417439039853 Facets: TotalItems: title: TotalItems required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Facets1: title: Facets1 required: - origin - currencyCode type: object properties: origin: $ref: '#/components/schemas/Origin1' currencyCode: $ref: '#/components/schemas/CurrencyCode1' example: origin: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: currencyCode: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: Origin1: title: Origin1 required: - Fulfillment - Marketplace type: object properties: Fulfillment: $ref: '#/components/schemas/Fulfillment1' Marketplace: $ref: '#/components/schemas/Marketplace2' example: Fulfillment: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: Fulfillment1: title: Fulfillment1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 68 Max: 1 Mean: 1 Min: 1 Missing: 0 StdDev: 0 Sum: 68 SumOfSquares: 68 Facets: Marketplace2: title: Marketplace2 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 16 Max: 89 Mean: 7.4375 Min: 1 Missing: 0 StdDev: 21.92401651157926 Sum: 119 SumOfSquares: 8095 Facets: CurrencyCode1: title: CurrencyCode1 required: - BRL type: object properties: BRL: $ref: '#/components/schemas/BRL1' example: BRL: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: BRL1: title: BRL1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer format: int32 description: Count. Max: type: integer format: int32 description: Maximum. Mean: type: number description: Mean. Min: type: integer format: int32 description: Minimum. Missing: type: integer format: int32 description: Missing. StdDev: type: number description: Standard deviation. Sum: type: integer format: int32 description: Sum. SumOfSquares: type: integer format: int64 description: Sum of squares. Facets: type: string nullable: true description: Facets. example: Count: 84 Max: 89 Mean: 2.2261904761904763 Min: 1 Missing: 0 StdDev: 9.660940100525016 Sum: 187 SumOfSquares: 8163 Facets: InvoiceNotificationRequest: title: InvoiceNotificationRequest required: - type - issuedDate - invoiceNumber - invoiceValue - items type: object properties: type: type: string description: 'The type of invoice. There are two possible values: `"Output"` and `"Input"`. The `"Output"` type should be used when the invoice you are sending is a selling invoice. The `"Input"` type should be used when you send a return invoice.' example: Output issuedDate: type: string description: Issuance date of the invoice in ISO format. example: '2020-07-15' invoiceNumber: type: string description: Number that identifies the invoice. example: '123456789' invoiceValue: type: string description: Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`. example: 2499 extraValue: type: integer description: Extra value in the invoice in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`. example: 100 invoiceKey: type: string nullable: true description: Invoice key. invoiceUrl: type: string description: URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations. courier: type: string nullable: true description: "The name of the carrier responsible for delivering the order.\n\r> This field should only be used when sending **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)." trackingNumber: type: string nullable: true description: "Code that identifies the order tracking.\n\r> This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)." trackingUrl: type: string nullable: true description: "URL used to track the order.\n\r> This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)." items: type: array items: $ref: '#/components/schemas/Item1' description: Array containing the SKUs that are being invoiced. cfop: type: string description: Fiscal code used in Brazil. example: '6.104' volumes: type: integer description: Number of volumes in the invoice. example: 3 example: type: Output issuedDate: '2019-01-30' invoiceNumber: '9999' invoiceValue: 2499 extraValue: 100 invoiceKey: invoiceUrl: courier: trackingNumber: trackingUrl: items: - id: '1234' price: 10000 quantity: 1 Item1: title: Item1 required: - itemIndex - price - quantity type: object properties: itemIndex: type: string description: Index of the SKU being invoiced. example: 67 price: type: integer format: int32 description: Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`. example: 2499 quantity: type: integer format: int32 description: Quantity cof the SKU being invoiced. example: 3 example: id: '1234' price: 10000 quantity: 1 parameters: Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string example: application/json 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 orderId: name: orderId in: path description: ID of the order. required: true style: simple schema: type: string example: 70caf3941s6df1 reason: name: reason in: query description: Reason for requesting unmasked data. required: false style: form schema: type: string example: data-validation 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 paymentId: name: paymentId in: path description: ID of the payment. required: true style: simple schema: type: string example: 45hsfg5jkyu1384jdsfgh654sfgj1 tags: - name: Invoice - name: Orders - name: Payment