openapi-directory/api/vtex.local/Orders-API-(PII-version).json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"VTEX server url","url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL"},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"info":{"contact":{},"description":"Endpoints that deal with order management. New version of the orders API.","title":"Orders API (PII version)","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Orders API (PII version).json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Orders-API-(PII-version)"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Orders"},{"name":"Invoice"},{"name":"Tracking"},{"name":"Conversation"},{"name":"Payment"},{"name":"Feed v3"},{"name":"Order hook"},{"name":"Export order report"},{"name":"User orders"},{"name":"Change seller"}],"paths":{"/api/orders/extendsearch/orders":{"post":{"deprecated":false,"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<div class=\"alert alert-info\">Pagination Limit: The limit of pages that can be requested is 30.\r\n</div>\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":{"properties":{"f_creationDate":{"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]","type":"string"},"page":{"description":"Number of the page to be retrieved.","example":1,"type":"integer"},"per_page":{"description":"Number of orders per page.","example":15,"type":"integer"},"q":{"description":"Full-text search for the orders.","example":"Postman Test","type":"string"}},"required":["f_creationDate","per_page","page"],"type":"object"}}}},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"facets":[],"list":[{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"J C","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502559llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Boleto Bancário","salesChannel":"1","sequence":"502559","status":"invoiced","statusDescription":"Faturado","totalItems":1,"totalValue":7453,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"Rodrigo VTEX","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502556llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Boleto Bancário","salesChannel":"1","sequence":"502556","status":"handling","statusDescription":"Preparando Entrega","totalItems":1,"totalValue":1160,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"test test","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502553llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Mastercard","salesChannel":"1","sequence":"502554","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":10150,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"test test","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502550llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Mastercard","salesChannel":"1","sequence":"502551","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":10150,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"test test","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502547llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Mastercard","salesChannel":"1","sequence":"502548","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":10150,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":null,"callCenterOperatorName":null,"clientName":"test test","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"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","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502544llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Boleto Bancário","salesChannel":"1","sequence":"502544","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":8990,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":null,"callCenterOperatorName":null,"clientName":"Douglas Rodrigues","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"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","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502541llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Boleto Bancário","salesChannel":"1","sequence":"502541","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":3290,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"test test","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc","listId":null,"listType":null,"marketPlaceOrderId":null,"orderId":"v502538llux-01","orderIsComplete":true,"origin":"Marketplace","paymentNames":"Mastercard","salesChannel":"1","sequence":"502538","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":8990,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":"cancelamento teste shp ","listId":null,"listType":null,"marketPlaceOrderId":"880102018018-01","orderId":"SCP-880102018018-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502537","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":null,"listId":null,"listType":null,"marketPlaceOrderId":"880091692043-01","orderId":"SCP-880091692043-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502536","status":"invoiced","statusDescription":"Faturado","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":"Teste de cancelamento do ShopFácil ","listId":null,"listType":null,"marketPlaceOrderId":"880091058221-01","orderId":"SCP-880091058221-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502535","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":null,"listId":null,"listType":null,"marketPlaceOrderId":"880090643370-01","orderId":"SCP-880090643370-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502534","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":null,"callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":null,"listId":null,"listType":null,"marketPlaceOrderId":"880090622238-01","orderId":"SCP-880090622238-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502533","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":null,"ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"MNC","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"Carlos VTEX","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":null,"listId":null,"listType":null,"marketPlaceOrderId":"877730530419-01","orderId":"MNC-877730530419-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502532","status":"canceled","statusDescription":"Cancelado","totalItems":1,"totalValue":11150,"workflowInErrorState":false,"workflowInRetry":false},{"ShippingEstimatedDate":"2025-06-15T13:48:48.720Z","ShippingEstimatedDateMax":null,"ShippingEstimatedDateMin":null,"affiliateId":"SCP","authorizedDate":"2025-06-15T13:48:48.720Z","callCenterOperatorName":null,"clientName":"roberta grecco","creationDate":"2025-06-15T13:48:48.720Z","currencyCode":"BRL","items":null,"lastMessageUnread":null,"listId":null,"listType":null,"marketPlaceOrderId":"876733475998-01","orderId":"SCP-876733475998-01","orderIsComplete":true,"origin":"Fulfillment","paymentNames":"","salesChannel":"1","sequence":"502531","status":"ready-for-handling","statusDescription":"Pronto para o manuseio","totalItems":1,"totalValue":1250,"workflowInErrorState":false,"workflowInRetry":false}],"paging":{"currentPage":1,"pages":6,"perPage":15,"total":84},"stats":{"stats":{"totalItems":{"Count":84,"Facets":{"currencyCode":{"BRL":{"Count":84,"Facets":null,"Max":89,"Mean":2.2261904761904763,"Min":1,"Missing":0,"StdDev":9.660940100525016,"Sum":187,"SumOfSquares":8163}},"origin":{"Fulfillment":{"Count":68,"Facets":null,"Max":1,"Mean":1,"Min":1,"Missing":0,"StdDev":0,"Sum":68,"SumOfSquares":68},"Marketplace":{"Count":16,"Facets":null,"Max":89,"Mean":7.4375,"Min":1,"Missing":0,"StdDev":21.92401651157926,"Sum":119,"SumOfSquares":8095}}},"Max":89,"Mean":2.2261904761904763,"Min":1,"Missing":0,"StdDev":9.660940100525016,"Sum":187,"SumOfSquares":8163},"totalValue":{"Count":84,"Facets":{"currencyCode":{"BRL":{"Count":84,"Facets":null,"Max":21526180,"Mean":262672.75,"Min":1160,"Missing":0,"StdDev":2348087.3869179883,"Sum":22064511,"SumOfSquares":463417439039853}},"origin":{"Fulfillment":{"Count":68,"Facets":null,"Max":11150,"Mean":1395.5882352941176,"Min":1250,"Missing":0,"StdDev":1200.5513439298484,"Sum":94900,"SumOfSquares":229010000},"Marketplace":{"Count":16,"Facets":null,"Max":21526180,"Mean":1373100.6875,"Min":1160,"Missing":0,"StdDev":5374326.141087491,"Sum":21969611,"SumOfSquares":463417210029853}}},"Max":21526180,"Mean":262672.75,"Min":1160,"Missing":0,"StdDev":2348087.3869179883,"Sum":22064511,"SumOfSquares":463417439039853}}}},"schema":{"$ref":"#/components/schemas/ListOrders"}}},"description":"OK","headers":{"Cache-Control":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Connection":{"content":{"text/plain":{"example":"close","schema":{"type":"string"}}}},"Content-Encoding":{"content":{"text/plain":{"example":"gzip","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Mon, 13 Feb 2017 15:25:12 GMT","schema":{"type":"string"}}}},"Expires":{"content":{"text/plain":{"example":"-1","schema":{"type":"string"}}}},"Pragma":{"content":{"text/plain":{"example":"no-cache","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"Vary":{"content":{"text/plain":{"example":"Accept-Encoding","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.35.3","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"omsapi-v1.5.135","schema":{"type":"string"}}}}}}},"summary":"List orders","tags":["Orders"]}},"/api/orders/pvt/document/{orderId}":{"get":{"deprecated":false,"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| `curr