get https://{accountName}.{environment}.com.br/api/oms/user/orders
Lists all orders from a given client, filtering by their email.
Request object has the following properties:
| Attribute | Type | Description |
|---|---|---|
email | string | Client e-mail |
pageNumber | string | Page number for result pagination |
pageSize | string | Page quantity for result pagination |
Response object has the following properties:
| Attribute | Type | Description |
|---|---|---|
list | object | Order List Object |
orderId | string | Order ID |
creationDate | string | Order Creation Date |
clientName | string | Order Client Name |
items | object | Obsolete Field |
totalValue | integer | Total Value Amount |
paymentNames | string | Payment System Name |
status | string | Order Status |
statusDescription | string | Status Description |
marketplaceOrderId | string | Marketplace Order Id |
sequence | string | Order Sequence ID |
salesChannel | string | Order Sales Channel Id |
affiliateId | string | Seller Name who was responsible for the order |
origin | string | Order Origin: "Marketplace" or "Fulfillment" |
workflowInErrorState | boolean | If is a Work Flow Error |
workflowInRetry | boolean | If is in a Work Flow Retry |
lastMessageUnread | string | Last sent transactional message |
shippingEstimateDate | string | Estimate Shipping Date |
ShippingEstimatedDateMax | string | ??? |
ShippingEstimatedDateMin | string | ??? |
orderIsComplete | boolean | If is a Order Completed |
listId | string | Releated Gift List Id |
listType | string | Releated Gift List Type |
authorizedDate | string | Authorized Order Date |
callCenterOperatorData | string | Call Center Operator responsible for the order |
totalItems | integer | Total Order Items |
currencyCode | string | Currency Code in ISO 4217 |
Request body example
curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/oms/user/orders/?clientEmail={{email}}&page={{pageNumber}}&per_page={{pageSize}}' \
--header 'Accept: application/json'
Response body example
{
"list": [
{
"orderId": "v502556llux-01",
"creationDate": "2019-01-28T20:09:43.0000000+00:00",
"clientName": "Cunha VTEX",
"items": null,
"totalValue": 1160,
"paymentNames": "Boleto Bancário",
"status": "handling",
"statusDescription": "Preparando Entrega",
"marketPlaceOrderId": null,
"sequence": "502556",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ",
"ShippingEstimatedDate": "2019-02-04T20:33:46.0000000+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": "2019-01-28T20:33:04.0000000+00:00",
"callCenterOperatorName": null,
"totalItems": 1,
"currencyCode": "BRL"
},
{
"orderId": "v502449llux-02",
"creationDate": "2018-08-28T17:42:40.0000000+00:00",
"clientName": "Cunha VTEX",
"items": null,
"totalValue": 118588,
"paymentNames": "Promissory",
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": null,
"sequence": "502452",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502449llux-02 Resumo Itens R$ 1.178,98 Entrega R$ 6,90 Total R$ 1.185,88",
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 12,
"currencyCode": "BRL"
},
{
"orderId": "v502449llux-01",
"creationDate": "2018-08-28T17:42:28.9171556+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Mangueira Reservatório Ao Cavalete",
"ean": null,
"refId": "TE3121110",
"id": "195",
"productId": "134",
"sellingPrice": 7390,
"price": 7390
},
{
"seller": "1",
"quantity": 1,
"description": "Mangueira Filtro",
"ean": null,
"refId": "XC459N610CA",
"id": "238",
"productId": "162",
"sellingPrice": 5190,
"price": 5190
}
],
"totalValue": 21526180,
"paymentNames": null,
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "",
"sequence": "502449",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v502058llux-01",
"creationDate": "2017-07-25T23:17:36.7963248+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Aquecedor Britania 1500 Branco",
"ean": "1235567890143",
"refId": "branquinho",
"id": "1234568212",
"productId": "1000200",
"sellingPrice": 35599,
"price": 35599
}
],
"totalValue": 35599,
"paymentNames": null,
"status": "invoiced",
"statusDescription": "Faturado",
"marketPlaceOrderId": "",
"sequence": "502058",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2017-07-29T19:24:20.7444363+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v501538llux-01",
"creationDate": "2017-06-26T16:57:58.9986524+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Boneco do Mário",
"ean": "bonecomario",
"refId": "bonecomario",
"id": "1234568183",
"productId": "1000257",
"sellingPrice": 150363,
"price": 150363
},
{
"seller": "1",
"quantity": 1,
"description": "Camiseta GG",
"ean": null,
"refId": "abc1234",
"id": "1234567894",
"productId": "1000187",
"sellingPrice": 899,
"price": 899
}
],
"totalValue": 151262,
"paymentNames": null,
"status": "invoiced",
"statusDescription": "Faturado",
"marketPlaceOrderId": "",
"sequence": "501538",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2017-06-27T13:59:49.7705236+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v501020llux-01",
"creationDate": "2016-11-21T19:57:54.0415289+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 2,
"description": "Camiseta GG",
"ean": null,
"refId": "abc1234",
"id": "1234567894",
"productId": "1000187",
"sellingPrice": 899,
"price": 899
}
],
"totalValue": 3190,
"paymentNames": null,
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "",
"sequence": "501020",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2016-12-02T08:00:00.0000000+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v500973llux-01",
"creationDate": "2016-10-10T17:19:30.8562035+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1\" 4G CÂMERA 12 MP",
"ean": null,
"refId": "testefnac",
"id": "1234568028",
"productId": "1000203",
"sellingPrice": 299000,
"price": 299000
}
],
"totalValue": 299900,
"paymentNames": null,
"status": "handling",
"statusDescription": "Preparando Entrega",
"marketPlaceOrderId": "",
"sequence": "500973",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2016-10-10T14:23:17.1897068+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v500970llux-01",
"creationDate": "2016-10-10T17:07:59.0889392+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Camiseta GG",
"ean": null,
"refId": "abc1234",
"id": "1234567894",
"productId": "1000187",
"sellingPrice": 899,
"price": 899
}
],
"totalValue": 1799,
"paymentNames": null,
"status": "invoiced",
"statusDescription": "Faturado",
"marketPlaceOrderId": "",
"sequence": "500970",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": "2016-10-10T14:13:34.4927265+00:00",
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v500890llux-01",
"creationDate": "2016-08-17T18:35:04.8659804+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M",
"ean": "absolutm",
"refId": null,
"id": "549",
"productId": "9",
"sellingPrice": 1000,
"price": 1000
}
],
"totalValue": 1000,
"paymentNames": null,
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "",
"sequence": "500890",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
},
{
"orderId": "v500838llux-01",
"creationDate": "2016-07-29T00:20:47.7736718+00:00",
"clientName": "Cunha VTEX",
"items": [
{
"seller": "1",
"quantity": 1,
"description": "Rooibos Lavanda - Pouch - 50gr",
"ean": "198",
"refId": "10098",
"id": "98",
"productId": "1000025",
"sellingPrice": 5200,
"price": 5200
}
],
"totalValue": 6200,
"paymentNames": null,
"status": "canceled",
"statusDescription": "Cancelado",
"marketPlaceOrderId": "",
"sequence": "500838",
"salesChannel": "1",
"affiliateId": "",
"origin": "Marketplace",
"workflowInErrorState": false,
"workflowInRetry": false,
"lastMessageUnread": null,
"ShippingEstimatedDate": null,
"ShippingEstimatedDateMax": null,
"ShippingEstimatedDateMin": null,
"orderIsComplete": true,
"listId": null,
"listType": null,
"authorizedDate": null,
"callCenterOperatorName": null,
"totalItems": 0,
"currencyCode": null
}
],
"facets": [],
"paging": {
"total": 19,
"pages": 10,
"currentPage": 1,
"perPage": 2
},
"stats": {
"stats": {
"totalValue": {
"Count": 19,
"Max": 0,
"Mean": 0,
"Min": 0,
"Missing": 0,
"StdDev": 0,
"Sum": 0,
"SumOfSquares": 0,
"Facets": {}
},
"totalItems": {
"Count": 19,
"Max": 0,
"Mean": 0,
"Min": 0,
"Missing": 0,
"StdDev": 0,
"Sum": 0,
"SumOfSquares": 0,
"Facets": {}
}
}
}
}