Skip to main content
GET
/
v1
/
shipments
cURL
curl --request GET \
  --url https://api.goevery.co/v1/shipments \
  --header 'Authorization: Bearer <token>'
{
  "shipments": [
    {
      "name": "shipments/669a8cba6af86466a42de2fe",
      "createTime": "2024-07-17T21:32:52.478Z",
      "updateTime": "2024-07-17T21:32:52.478Z",
      "quote": "quotes/669986bb4ae1239d5a92cdff",
      "courier": "couriers/coordinadora",
      "origin": "origins/66343b5ac38abe08414dc303",
      "recipient": {
        "firstName": "Valentina",
        "lastName": "Rodríguez López",
        "email": "valentina@gmail.com",
        "phoneNumber": "+573193210329",
        "address": {
          "regionCode": "CO",
          "administrativeArea": "Antioquia",
          "locality": "Abejorral",
          "addressLines": [
            "Calle 123",
            "Apto 2"
          ],
          "organization": "Happeett"
        },
        "documentType": "CC",
        "document": "1040777098"
      },
      "requiresPickup": true,
      "status": "LABEL_GENERATED",
      "shipmentCostCents": 1700000,
      "cashOnDeliveryCostCents": 350000,
      "totalCostCents": 2050000,
      "label": "240013993254",
      "labelUrl": "https://storage.googleapis.com/every-shipment-labels-production/690cd6eb79ac31909b2121e8.pdf?GoogleAccessId=..."
    }
  ],
  "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.

Response

200 - application/json

Successfully fetched a list of shipments.

​
shipments
object[]
required

An array of shipments.

​
nextPageToken
string | null

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