Ecartapi.com Public API Documentation
Get orders
GET https://api.ecartapi.com/api/v2/orders
This HTTP GET request retrieves a list of orders from the Tiny e-commerce platform. By default, 100 records are listed per page. The response returns a JSON object with a Each order object includes information such as ID, number, fulfillment status, currency, discounts, totals, dimensions, taxes, status, payment method, customer details, billing and shipping addresses, dates, and other relevant order-related data. You can find more information about the API resource used in the Tiny Orders API documentation.success
key indicating the success status, and an array of orders
containing details about each order.
Body
PARAM
| Key | Datatype | Required | Description |
status[ecartapi]
|
string | Allowed values [pending, paid, authorized, other, shipped, refunded, cancelled] | |
sort
|
string | Default DESC, Allowd values [ASC,DESC] | |
createdAt[from]
|
string | ||
createdAt[to]
|
string |
HEADERS
| Key | Datatype | Required | Description |
Authorization
|
string |
RESPONSES
status OK
| {
"success": true,
"orders": [
{
"id": "894226335",
"number": null,
"marketPlaceId": null,
"groupId": null,
"name": null,
"packsId": null,
"email": null,
"fulfillmentStatus": {
"id": null,
"status": "Preparando envio",
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": null
},
"currency": null,
"discountsCoupon": [],
"totals": {
"subtotal": null,
"total": 100,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": null,
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Preparando envio",
"financial": "Preparando envio",
"ecartapi": "authorized",
"ecartapiId": "7"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": null,
"status": "paid",
"ecartapi": "1"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"logistic": {
"mode": null,
"type": null,
"free": "false",
"direction": null
},
"shippingMethod": null,
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"estimatedDeliveryIn": null,
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "30/05/2023",
"updatedAt": null,
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null,
"fraudRisk": null,
"events": []
},
{
"id": "964752660",
"number": null,
"marketPlaceId": null,
"groupId": null,
"name": null,
"packsId": null,
"email": null,
"fulfillmentStatus": {
"id": null,
"status": "Em aberto",
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": null
},
"currency": null,
"discountsCoupon": [],
"totals": {
"subtotal": null,
"total": 10,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": null,
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Em aberto",
"financial": "Em aberto",
"ecartapi": "pending",
"ecartapiId": "2"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": null,
"status": "pending",
"ecartapi": "2"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"logistic": {
"mode": null,
"type": null,
"free": "false",
"direction": null
},
"shippingMethod": null,
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"estimatedDeliveryIn": null,
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "11/08/2023",
"updatedAt": null,
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null,
"fraudRisk": null,
"events": []
},
{
"id": "964761464",
"number": null,
"marketPlaceId": null,
"groupId": null,
"name": null,
"packsId": null,
"email": null,
"fulfillmentStatus": {
"id": null,
"status": "Em aberto",
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": null
},
"currency": null,
"discountsCoupon": [],
"totals": {
"subtotal": null,
"total": 10,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": null,
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Em aberto",
"financial": "Em aberto",
"ecartapi": "pending",
"ecartapiId": "2"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": null,
"status": "pending",
"ecartapi": "2"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"logistic": {
"mode": null,
"type": null,
"free": "false",
"direction": null
},
"shippingMethod": null,
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"estimatedDeliveryIn": null,
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "11/08/2023",
"updatedAt": null,
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null,
"fraudRisk": null,
"events": []
},
{
"id": "964764784",
"number": null,
"marketPlaceId": null,
"groupId": null,
"name": null,
"packsId": null,
"email": null,
"fulfillmentStatus": {
"id": null,
"status": "Em aberto",
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": null
},
"currency": null,
"discountsCoupon": [],
"totals": {
"subtotal": null,
"total": 10,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": null,
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Em aberto",
"financial": "Em aberto",
"ecartapi": "pending",
"ecartapiId": "2"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": null,
"status": "pending",
"ecartapi": "2"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"logistic": {
"mode": null,
"type": null,
"free": "false",
"direction": null
},
"shippingMethod": null,
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"estimatedDeliveryIn": null,
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "11/08/2023",
"updatedAt": null,
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null,
"fraudRisk": null,
"events": []
},
{
"id": "964765645",
"number": null,
"marketPlaceId": null,
"groupId": null,
"name": null,
"packsId": null,
"email": null,
"fulfillmentStatus": {
"id": null,
"status": "Aprovado",
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": null
},
"currency": null,
"discountsCoupon": [],
"totals": {
"subtotal": null,
"total": 10,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": null,
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Aprovado",
"financial": "Aprovado",
"ecartapi": "authorized",
"ecartapiId": "7"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": null,
"status": "paid",
"ecartapi": "1"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"logistic": {
"mode": null,
"type": null,
"free": "false",
"direction": null
},
"shippingMethod": null,
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"estimatedDeliveryIn": null,
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "11/08/2023",
"updatedAt": null,
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null,
"fraudRisk": null,
"events": []
}
]
} |
Curl
curl -X GET 'https://api.ecartapi.com/api/v2/orders?status[ecartapi]=String&sort=String&createdAt[from]=YYYY-MM-DD&createdAt[to]=YYYY-MM-DD' -H 'Authorization: access_token'
ENDPOINTS