Skip to main content
GET
/
v1
/
orders
cURL
curl --request GET \
  --url https://api.goevery.co/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "orders": [
    {
      "name": "orders/669a8cba6af86466a42de2fe",
      "createTime": "2024-07-17T21:32:52.478Z",
      "updateTime": "2024-07-17T21:32:52.478Z",
      "status": "NEW",
      "recipient": {
        "firstName": "Valentina",
        "lastName": "Rodríguez López",
        "email": "[email protected]",
        "phoneNumber": "+573193210329",
        "address": {
          "regionCode": "CO",
          "administrativeArea": "Antioquia",
          "locality": "Abejorral",
          "addressLines": [
            "Calle 123",
            "Apto 2"
          ],
          "organization": "Happeett"
        },
        "location": "locations/CO-11001000",
        "documentType": "CC",
        "document": "1040777098"
      },
      "contentDescription": "Shoes",
      "notes": "1 Pair of Reebok Nano, Size 8, Color Black",
      "sellingPriceCents": 1430000,
      "cashOnDeliveryRequestCents": 8900000,
      "customerReliability": "RELIABLE",
      "customerBehavior": {
        "totalShipments": 10,
        "deliveredShipments": 8,
        "returnedShipments": 2,
        "reliability": "RELIABLE"
      },
      "shipment": "shipments/669986bb4ae1239d5a92cdff",
      "referenceId": "4012",
      "referenceGid": "93240958723",
      "referenceUrl": "https://mystore.com/order/1234567890",
      "paymentMethods": [
        "cash_on_delivery",
        "credit_card"
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
number | null

The maximum number of locations to return. Defaults to 100 if not specified. Must be a positive number and not exceed 1000.

Required range: x <= 1000
Example:

100

​
pageToken
string | null

A token to retrieve the next page of results. Used for pagination.

​
status
string | null

Filter orders by status. Accepts a comma-separated list of statuses. Valid values: NEW, CONFIRMED, READY, IN_PROGRESS, CANCELLED, DELIVERED, RETURN.

Example:

"NEW,CONFIRMED"

​
query
string | null

Search orders by recipient name, phone number, or reference ID. Performs fuzzy matching on recipient names and exact matching on phone numbers and reference IDs.

Example:

"Valentina"

Response

200 - application/json

Successfully fetched a list of orders.

​
orders
object[]
required

An array of orders.

​
nextPageToken
string | null

A token to retrieve the next page of results, if any.