List 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": "[email protected]",
        "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>"
}

GET

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": "[email protected]",
        "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.

Show child attributes

shipments.name

string

required

The unique identifier of the shipment.

Example:

"shipments/669a8cba6af86466a42de2fe"

shipments.createTime

string

required

The timestamp when the shipment was created.

Example:

"2024-07-17T21:32:52.478Z"

shipments.updateTime

string

required

The timestamp when the shipment was last updated.

Example:

"2024-07-17T21:32:52.478Z"

shipments.quote

string

required

The unique identifier for the accepted quote.

Example:

"quotes/669986bb4ae1239d5a92cdff"

shipments.courier

string

required

The name of the courier service handling the shipment.

Example:

"couriers/coordinadora"

shipments.origin

string

required

The resource name of the selected origin location.

Example:

"origins/66343b5ac38abe08414dc303"

shipments.recipient

object

required

Details of the recipient of the shipment.

Show child attributes

shipments.recipient.firstName

string

required

The first name of the shipment recipient.

Example:

"Valentina"

shipments.recipient.lastName

string

required

The last name of the shipment recipient.

Example:

"Rodríguez López"

shipments.recipient.email

string

required

The email address of the recipient.

Example:

"[email protected]"

shipments.recipient.phoneNumber

string

required

The phone number of the recipient.

Example:

"+573193210329"

shipments.recipient.address

object

required

The address details.

Show child attributes

shipments.recipient.address.regionCode

string

required

The ISO 3166-1 alpha-2 region code representing the country or territory.

Example:

"CO"

shipments.recipient.address.administrativeArea

string

required

The primary administrative division, such as a state or province, within the region.

Example:

"Antioquia"

shipments.recipient.address.locality

string

required

The specific city, town, or municipality.

Example:

"Abejorral"

shipments.recipient.address.addressLines

string[]

required

Two lines detailing the specific street address, including street name, building number, apartment or suite number, and any other relevant details.

Example:

["Calle 123", "Apto 2"]

shipments.recipient.address.organization

string

required

The name of the organization associated with this address, if applicable.

Example:

"Happeett"

shipments.recipient.documentType

enum<string> | null

The type of document identifying the recipient.

Available options:

CC,

CE,

NI,

TI

Example:

"CC"

shipments.recipient.document

string | null

The document number of the recipient.

Example:

"1040777098"

shipments.requiresPickup

boolean

required

Indicates whether the shipment requires pickup by the courier.

shipments.status

enum<string>

required

The current status of the shipment.

Available options:

GENERATING_LABEL,

LABEL_GENERATED,

SCHEDULED_PICKUP,

IN_PROGRESS,

AT_ORIGIN_TERMINAL,

AT_DESTINATION_TERMINAL,

READY_FOR_PICKUP,

OUT_FOR_DELIVERY,

DELIVERED,

WITH_ERROR,

CANCELLATION_REQUESTED,

CANCELLED,

RETURN

Example:

"LABEL_GENERATED"

shipments.shipmentCostCents

number

required

The cost of the shipment in cents (COP).

Example:

1700000

shipments.cashOnDeliveryCostCents

number

required

The cash on delivery service cost in cents (COP).

Example:

350000

shipments.totalCostCents

number

required

The total cost of the shipment including all fees in cents (COP).

Example:

2050000

shipments.label

string | null

The label identifier for the shipment.

Example:

"240013993254"

shipments.labelUrl

string | null

A signed URL to download the shipment label PDF. Valid for 120 hours (5 days).

Example:

"https://storage.googleapis.com/every-shipment-labels-production/690cd6eb79ac31909b2121e8.pdf?GoogleAccessId=..."

nextPageToken

string | null

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

Create Shipment Get Shipment

⌘I

Guías

Shipping

Authorizations

Query Parameters

Response