List 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>"
}

GET

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.

Show child attributes

orders.name

string

required

The unique identifier of the order.

Example:

"orders/669a8cba6af86466a42de2fe"

orders.createTime

string

required

The timestamp when the order was created.

Example:

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

orders.updateTime

string

required

The timestamp when the order was last updated.

Example:

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

orders.status

enum<string>

required

The current status of the order.

Available options:

NEW,

CONFIRMED,

READY,

IN_PROGRESS,

CANCELLED,

DELIVERED,

RETURN

Example:

"NEW"

orders.recipient

object

required

Details of the recipient of the order.

Show child attributes

orders.recipient.firstName

string

required

The first name of the order recipient.

Example:

"Valentina"

orders.recipient.lastName

string

required

The last name of the order recipient.

Example:

"Rodríguez López"

orders.recipient.email

string

required

The email address of the recipient.

Example:

"[email protected]"

orders.recipient.phoneNumber

string

required

The phone number of the recipient.

Example:

"+573193210329"

orders.recipient.address

object

required

The address details.

Show child attributes

orders.recipient.address.regionCode

string

required

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

Example:

"CO"

orders.recipient.address.administrativeArea

string

required

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

Example:

"Antioquia"

orders.recipient.address.locality

string

required

The specific city, town, or municipality.

Example:

"Abejorral"

orders.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"]

orders.recipient.address.organization

string

required

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

Example:

"Happeett"

orders.recipient.location

string

required

The resource name of the destination location.

Maximum string length: 96

Example:

"locations/CO-11001000"

orders.recipient.documentType

enum<string> | null

The type of document identifying the recipient.

Available options:

CC,

CE,

NI,

TI

Example:

"CC"

orders.recipient.document

string | null

The document number of the recipient.

Example:

"1040777098"

orders.contentDescription

string

required

A description of the package content.

Required string length: 3 - 128

Example:

"Shoes"

orders.notes

string

required

A detailed description of the contents of this package and additional information.

Required string length: 3 - 2048

Example:

"1 Pair of Reebok Nano, Size 8, Color Black"

orders.sellingPriceCents

number

required

The order selling price, just for reporting purposes.

Example:

1430000

orders.cashOnDeliveryRequestCents

number

required

The amount to be collected on delivery in cents.

Required range: x >= 0

Example:

8900000

orders.customerReliability

enum<string>

required

The reliability of the customer.

Available options:

RELIABLE,

MODERATE,

UNRELIABLE,

NO_ORDERS

Example:

"RELIABLE"

orders.customerBehavior

object

required

Show child attributes

orders.customerBehavior.totalShipments

number

required

The total number of shipments made by the customer.

Example:

10

orders.customerBehavior.deliveredShipments

number

required

The total number of shipments delivered by the customer.

Example:

8

orders.customerBehavior.returnedShipments

number

required

The total number of shipments returned by the customer.

Example:

2

orders.customerBehavior.reliability

enum<string>

required

The reliability of the customer.

Available options:

RELIABLE,

MODERATE,

UNRELIABLE,

NO_ORDERS

Example:

"RELIABLE"

orders.shipment

string

The unique identifier for the associated shipment.

Example:

"shipments/669986bb4ae1239d5a92cdff"

orders.referenceId

string

The ID of the order in the external system that created it, like Shopify order name.

Example:

"4012"

orders.referenceGid

string

The global identifier of the order in the external system, like Shopify order GID.

Example:

"93240958723"

orders.referenceUrl

string<uri>

The URL to the order in the external system, like Shopify order URL.

Example:

"https://mystore.com/order/1234567890"

orders.paymentMethods

string[]

Payment methods used for this order.

Example:

["cash_on_delivery", "credit_card"]

nextPageToken

string | null

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

Update Order Get Order

⌘I

Guías

Shipping

Authorizations

Query Parameters

Response