Vtex Listorders2 Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "ListOrders2",
"method": "POST",
"path": "/api/orders/extendsearch/orders",
"summary": "VTex List orders",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json; charset=utf-8",
"example": {
"list": [
{
"orderId": "v502559llux-01",
"creationDate": "2019-02-04T10:29:11+00:00",
"clientName": "J C",
"items": null,
"totalValue": 7453,
"paymentNames": "Boleto Banc\u00e1rio",
"status": "invoiced",
"statusDescription": "Faturado",
"marketPlaceOrderId": null,
"sequence": "502559",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Ol\u00e1, J. Estamos empacotando seu produto para providenci",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-02-07T21:29:54+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502556llux-01",
"creationDate": "2019-01-28T20:09:43+00:00",
"clientName": "Rodrigo VTEX",
"items": null,
"totalValue": 1160,
"paymentNames": "Boleto Banc\u00e1rio",
"status": "handling",
"statusDescription": "Preparando Entrega",
"marketPlaceOrderId": null,
"sequence": "502556",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Ol\u00e1, Rodrigo. Seu pedido foi alterado. Seguem informa\u00e7\u00f5es abaixo: ",
"ShippingEstimatedDate": "2019-02-04T20:33:46+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-01-28T20:33:04+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502553llux-01",
"creationDate": "2019-01-24T12:35:19+00:00",
"clientName": "test test",
"items": null,
"totalValue": 10150,
"paymentNames": "Mastercard",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": null,
"sequence": "502554",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Ol\u00e1, test. Estamos empacotando seu produto para provide",
"ShippingEstimatedDate": "2019-01-31T12:36:30+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-01-24T12:36:01+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502550llux-01",
"creationDate": "2019-01-23T16:39:45+00:00",
"clientName": "test test",
"items": null,
"totalValue": 10150,
"paymentNames": "Mastercard",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": null,
"sequence": "502551",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Ol\u00e1, test. Estamos providenciando a emiss\u00e3o da Nota Fisc",
"ShippingEstimatedDate": "2019-01-30T16:40:55+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-01-23T16:40:27+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502547llux-01",
"creationDate": "2019-01-23T16:34:20+00:00",
"clientName": "test test",
"items": null,
"totalValue": 10150,
"paymentNames": "Mastercard",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": null,
"sequence": "502548",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Ol\u00e1, test. Estamos providenciando a emiss\u00e3o da Nota Fisc",
"ShippingEstimatedDate": "2019-01-30T16:35:30+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-01-23T16:35:04+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502544llux-01",
"creationDate": "2018-12-28T18:15:28+00:00",
"clientName": "test test",
"items": null,
"totalValue": 8990,
"paymentNames": "Boleto Banc\u00e1rio",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": null,
"sequence": "502544",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502541llux-01",
"creationDate": "2018-12-18T18:48:17+00:00",
"clientName": "Douglas Rodrigues",
"items": null,
"totalValue": 3290,
"paymentNames": "Boleto Banc\u00e1rio",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": null,
"sequence": "502541",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502538llux-01",
"creationDate": "2018-12-12T18:21:47+00:00",
"clientName": "test test",
"items": null,
"totalValue": 8990,
"paymentNames": "Mastercard",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": null,
"sequence": "502538",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Ol\u00e1, test. Estamos providenciando a emiss\u00e3o da Nota Fisc",
"ShippingEstimatedDate": "2018-12-19T18:22:26+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-12-12T18:22:22+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-880102018018-01",
"creationDate": "2018-11-30T17:34:01+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "880102018018-01",
"sequence": "502537",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": "cancelamento teste shp ",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-30T17:34:42+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-880091692043-01",
"creationDate": "2018-11-30T17:28:35+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "invoiced",
"statusDescription": "Faturado",
"marketPlaceOrderId": "880091692043-01",
"sequence": "502536",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-30T17:29:22+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-880091058221-01",
"creationDate": "2018-11-30T17:18:00+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "880091058221-01",
"sequence": "502535",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": "Teste de cancelamento do ShopF\u00e1cil ",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-30T17:18:44+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-880090643370-01",
"creationDate": "2018-11-30T17:10:59+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": "880090643370-01",
"sequence": "502534",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2018-12-07T17:11:39+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-30T17:11:42+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-880090622238-01",
"creationDate": "2018-11-30T17:10:45+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "880090622238-01",
"sequence": "502533",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "MNC-877730530419-01",
"creationDate": "2018-11-20T21:09:01+00:00",
"clientName": "Carlos VTEX",
"items": null,
"totalValue": 11150,
"paymentNames": "",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "877730530419-01",
"sequence": "502532",
"salesChannel": "1",
"affiliateId": "MNC",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-20T21:13:06+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "SCP-876733475998-01",
"creationDate": "2018-11-16T16:58:18+00:00",
"clientName": "roberta grecco",
"items": null,
"totalValue": 1250,
"paymentNames": "",
"status": "ready-for-handling",
"statusDescription": "Pronto para o manuseio",
"marketPlaceOrderId": "876733475998-01",
"sequence": "502531",
"salesChannel": "1",
"affiliateId": "SCP",
"origin": "Fulfillment",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2018-11-23T16:58:48+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2018-11-16T16:58:53+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
}
],
"facets": [],
"paging": {
"total": 84,
"pages": 6,
"currentPage": 1,
"perPage": 15
},
"stats": {
"stats": {
"totalValue": {
"Count": 84,
"Max": 21526180,
"Mean": 262672.75,
"Min": 1160,
"Missing": 0,
"StdDev": 2348087.3869179883,
"Sum": 22064511,
"SumOfSquares": 463417439039853,
"Facets": {
"origin": {
"Fulfillment": {
"Count": 68,
"Max": 11150,
"Mean": 1395.5882352941176,
"Min": 1250,
"Missing": 0,
"StdDev": 1200.5513439298484,
"Sum": 94900,
"SumOfSquares": 229010000,
"Facets": null
},
"Marketplace": {
"Count": 16,
"Max": 21526180,
"Mean": 1373100.6875,
"Min": 1160,
"Missing": 0,
"StdDev": 5374326.141087491,
"Sum": 21969611,
"SumOfSquares": 463417210029853,
"Facets": null
}
},
"currencyCode": {
"BRL": {
"Count": 84,
"Max": 21526180,
"Mean": 262672.75,
"Min": 1160,
"Missing": 0,
"StdDev": 2348087.3869179883,
"Sum": 22064511,
"SumOfSquares": 463417439039853,
"Facets": null
}
}
}
},
"totalItems": {
"Count": 84,
"Max": 89,
"Mean": 2.2261904761904763,
"Min": 1,
"Missing": 0,
"StdDev": 9.660940100525016,
"Sum": 187,
"SumOfSquares": 8163,
"Facets": {
"origin": {
"Fulfillment": {
"Count": 68,
"Max": 1,
"Mean": 1,
"Min": 1,
"Missing": 0,
"StdDev": 0,
"Sum": 68,
"SumOfSquares": 68,
"Facets": null
},
"Marketplace": {
"Count": 16,
"Max": 89,
"Mean": 7.4375,
"Min": 1,
"Missing": 0,
"StdDev": 21.92401651157926,
"Sum": 119,
"SumOfSquares": 8095,
"Facets": null
}
},
"currencyCode": {
"BRL": {
"Count": 84,
"Max": 89,
"Mean": 2.2261904761904763,
"Min": 1,
"Missing": 0,
"StdDev": 9.660940100525016,
"Sum": 187,
"SumOfSquares": 8163,
"Facets": null
}
}
}
}
}
}
}
}
]
}