List Orders

Amb. de prod.

https://api.amo.delivery

GET

/v1/orders

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.amo.delivery/v1/orders?page=1&limit=5&start_date=2025-07-05&end_date=2025-07-07&delivery_type=DELIVERY&status=CONFIRMED&platform=AMO_OFFERS' \
--header 'Authorization: Bearer ...' \
--header 'x-merchant-id: 5e6b6de91575800011da1a3e'

Response Example

200 - Sucesso

{
    "paginate": {
        "page": 1,
        "limit": 5,
        "count": 217,
        "pages": 44
    },
    "docs": [
        {
            "id": "686bbf0c6622e77fc25c19e4",
            "type": "DELIVERY",
            "displayId": 5137,
            "createdAt": "2025-07-07T12:35:25.077Z",
            "lastEvent": "CONFIRMED",
            "orderTiming": "INSTANT",
            "preparationStartDateTime": "2025-07-07T12:35:25.077Z",
            "merchant": {
                "id": "5e6b6de91575800011da1a3e",
                "name": "Degustare Comida Artesanal"
            },
            "total": {
                "itemsPrice": {
                    "value": 38,
                    "currency": "BRL"
                },
                "otherFees": {
                    "value": 10.99,
                    "currency": "BRL"
                },
                "discount": {
                    "value": 0,
                    "currency": "BRL"
                },
                "orderAmount": {
                    "value": 48.99,
                    "currency": "BRL"
                }
            },
            "customer": {
                "id": "5e35b57ef9bea00018493438",
                "name": "Temp User",
                "phone": "4932323232",
                "email": "temp_user@yahoo.com.br"
            },
            "payments": {
                "prepaid": 0,
                "pending": 48.99,
                "methods": []
            },
            "metadata": {
                "platform": "amo_offers"
            }
        },
        {
            "id": "686b0f9ae8ae9f28ca7980ce",
            "type": "DELIVERY",
            "displayId": 5136,
            "createdAt": "2025-07-07T00:06:50.609Z",
            "lastEvent": "CONCLUDED",
            "orderTiming": "INSTANT",
            "preparationStartDateTime": "2025-07-07T00:06:50.609Z",
            "merchant": {
                "id": "5e6b6de91575800011da1a3e",
                "name": "Degustare Comida Artesanal"
            },
            "total": {
                "itemsPrice": {
                    "value": 79.9,
                    "currency": "BRL"
                },
                "otherFees": {
                    "value": 32.99,
                    "currency": "BRL"
                },
                "discount": {
                    "value": 0,
                    "currency": "BRL"
                },
                "orderAmount": {
                    "value": 112.89000000000001,
                    "currency": "BRL"
                }
            },
            "customer": {
                "id": "66b41d58e3a4b17dc7c7702f",
                "name": "Temp User",
                "phone": "4932323232",
                "email": "Temp User@gmail.com"
            },
            "payments": {
                "prepaid": 0,
                "pending": 112.89,
                "methods": []
            },
            "metadata": {
                "platform": "amo_offers"
            }
        },
        {
            "id": "686b08f104edd956a223d7ee",
            "type": "DELIVERY",
            "displayId": 5135,
            "createdAt": "2025-07-06T23:38:25.339Z",
            "lastEvent": "CONCLUDED",
            "orderTiming": "INSTANT",
            "preparationStartDateTime": "2025-07-06T23:38:25.339Z",
            "merchant": {
                "id": "5e6b6de91575800011da1a3e",
                "name": "Degustare Comida Artesanal"
            },
            "total": {
                "itemsPrice": {
                    "value": 92.9,
                    "currency": "BRL"
                },
                "otherFees": {
                    "value": 12.99,
                    "currency": "BRL"
                },
                "discount": {
                    "value": 0,
                    "currency": "BRL"
                },
                "orderAmount": {
                    "value": 105.89,
                    "currency": "BRL"
                }
            },
            "customer": {
                "id": "5f6d1da4d023060013b04e97",
                "name": "Temp User",
                "phone": "4932323232",
                "email": "Temp User@gmail.com"
            },
            "payments": {
                "prepaid": 0,
                "pending": 105.89,
                "methods": []
            },
            "metadata": {
                "platform": "amo_offers"
            }
        },
        {
            "id": "686b070704edd956a2239247",
            "type": "TAKEOUT",
            "displayId": 5134,
            "createdAt": "2025-07-06T23:30:15.912Z",
            "lastEvent": "CONCLUDED",
            "orderTiming": "INSTANT",
            "preparationStartDateTime": "2025-07-06T23:30:15.912Z",
            "merchant": {
                "id": "5e6b6de91575800011da1a3e",
                "name": "Degustare Comida Artesanal"
            },
            "total": {
                "itemsPrice": {
                    "value": 88.9,
                    "currency": "BRL"
                },
                "otherFees": {
                    "value": 0,
                    "currency": "BRL"
                },
                "discount": {
                    "value": 0,
                    "currency": "BRL"
                },
                "orderAmount": {
                    "value": 88.9,
                    "currency": "BRL"
                }
            },
            "customer": {
                "id": "5dcf0a1fb453a40012096808",
                "name": "Temp User",
                "phone": "4932323232",
                "email": "Temp User@gmail.com"
            },
            "payments": {
                "prepaid": 0,
                "pending": 88.9,
                "methods": []
            },
            "metadata": {
                "platform": "amo_offers"
            }
        },
        {
            "id": "686b068404edd956a2237f22",
            "type": "DELIVERY",
            "displayId": 5133,
            "createdAt": "2025-07-06T23:28:04.774Z",
            "lastEvent": "CONCLUDED",
            "orderTiming": "INSTANT",
            "preparationStartDateTime": "2025-07-06T23:28:04.774Z",
            "merchant": {
                "id": "5e6b6de91575800011da1a3e",
                "name": "Degustare Comida Artesanal"
            },
            "total": {
                "itemsPrice": {
                    "value": 79.9,
                    "currency": "BRL"
                },
                "otherFees": {
                    "value": 12.99,
                    "currency": "BRL"
                },
                "discount": {
                    "value": 0,
                    "currency": "BRL"
                },
                "orderAmount": {
                    "value": 92.89,
                    "currency": "BRL"
                }
            },
            "customer": {
                "id": "680d1c09cf9ceda949f2a868",
                "name": "Temp User",
                "phone": "4932323232",
                "email": "Temp User@gmail.com"
            },
            "payments": {
                "prepaid": 0,
                "pending": 92.89,
                "methods": []
            },
            "metadata": {
                "platform": "amo_offers"
            }
        }
    ]
}

Requisição

Parâmetros Query

Parâmetros Header

Respostas

🟢200Success

application/json

Body

🟠401Token inválido

🟠403Sem acesso ao recuros

Modificado em 2025-07-07 17:08:30