Create Quote

cURL

curl --request POST \
  --url https://api.goevery.co/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": "locations/CO-54003000",
  "destination": "locations/CO-11001000",
  "package": {
    "declaredValueCents": 4500000,
    "dimensions": {
      "lengthCm": 10,
      "widthCm": 20,
      "heightCm": 15
    },
    "weightKg": 2,
    "contentDescription": "Shoes"
  },
  "cashOnDeliveryRequestCents": 8900000,
  "order": "orders/66d86d4b05a7d437ac6c5379"
}
'

{
  "name": "quotes/669838849afe8a9d48db1c1e",
  "createTime": "2024-07-17T21:32:52.478Z",
  "updateTime": "2024-07-17T21:32:52.478Z",
  "origin": "locations/CO-54003000",
  "destination": "locations/CO-11001000",
  "package": {
    "declaredValueCents": 4500000,
    "dimensions": {
      "lengthCm": 10,
      "widthCm": 20,
      "heightCm": 15
    },
    "weightKg": 2,
    "contentDescription": "Shoes"
  },
  "cashOnDeliveryRequestCents": 8900000,
  "offers": [
    {
      "courier": "couriers/coordinadora",
      "status": "SUCCESS",
      "shipmentCostCents": 1430000,
      "returnShipmentCostCents": 930000,
      "deliveryMinutes": 1400
    }
  ],
  "order": "orders/66d86d4b05a7d437ac6c5379"
}

POST

quotes

cURL

curl --request POST \
  --url https://api.goevery.co/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": "locations/CO-54003000",
  "destination": "locations/CO-11001000",
  "package": {
    "declaredValueCents": 4500000,
    "dimensions": {
      "lengthCm": 10,
      "widthCm": 20,
      "heightCm": 15
    },
    "weightKg": 2,
    "contentDescription": "Shoes"
  },
  "cashOnDeliveryRequestCents": 8900000,
  "order": "orders/66d86d4b05a7d437ac6c5379"
}
'

{
  "name": "quotes/669838849afe8a9d48db1c1e",
  "createTime": "2024-07-17T21:32:52.478Z",
  "updateTime": "2024-07-17T21:32:52.478Z",
  "origin": "locations/CO-54003000",
  "destination": "locations/CO-11001000",
  "package": {
    "declaredValueCents": 4500000,
    "dimensions": {
      "lengthCm": 10,
      "widthCm": 20,
      "heightCm": 15
    },
    "weightKg": 2,
    "contentDescription": "Shoes"
  },
  "cashOnDeliveryRequestCents": 8900000,
  "offers": [
    {
      "courier": "couriers/coordinadora",
      "status": "SUCCESS",
      "shipmentCostCents": 1430000,
      "returnShipmentCostCents": 930000,
      "deliveryMinutes": 1400
    }
  ],
  "order": "orders/66d86d4b05a7d437ac6c5379"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

origin

string

required

The resource name of the origin location.

Maximum string length: 96

Example:

"locations/CO-54003000"

destination

string

required

The resource name of the destination location.

Maximum string length: 96

Example:

"locations/CO-11001000"

package

object

required

Details of the package to be quoted.

Show child attributes

package.declaredValueCents

number

required

The declared value of the package in cents.

Example:

4500000

package.dimensions

object

required

The dimensions of the package.

Show child attributes

package.dimensions.lengthCm

number

required

The length of the package in centimeters.

Example:

10

package.dimensions.widthCm

number

required

The width of the package in centimeters.

Example:

20

package.dimensions.heightCm

number

required

The height of the package in centimeters.

Example:

15

package.weightKg

number

required

The weight of the package in kilograms.

Example:

2

package.contentDescription

string

required

A description of the package content.

Required string length: 3 - 128

Example:

"Shoes"

cashOnDeliveryRequestCents

number

required

The amount to be collected on delivery in cents.

Required range: x >= 0

Example:

8900000

order

string | null

The unique identifier for the order associated with the shipment.

Example:

"orders/66d86d4b05a7d437ac6c5379"

Response

200 - application/json

Successfully created a quote.

name

string

required

The unique identifier for the quote.

Example:

"quotes/669838849afe8a9d48db1c1e"

createTime

string

required

The timestamp when the quote was created.

Example:

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

updateTime

string

required

The timestamp when the quote was last updated.

Example:

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

origin

string

required

The resource name of the origin location.

Maximum string length: 96

Example:

"locations/CO-54003000"

destination

string

required

The resource name of the destination location.

Maximum string length: 96

Example:

"locations/CO-11001000"

package

object

required

Details of the package to be quoted.

Show child attributes

package.declaredValueCents

number

required

The declared value of the package in cents.

Example:

4500000

package.dimensions

object

required

The dimensions of the package.

Show child attributes

package.dimensions.lengthCm

number

required

The length of the package in centimeters.

Example:

10

package.dimensions.widthCm

number

required

The width of the package in centimeters.

Example:

20

package.dimensions.heightCm

number

required

The height of the package in centimeters.

Example:

15

package.weightKg

number

required

The weight of the package in kilograms.

Example:

2

package.contentDescription

string

required

A description of the package content.

Required string length: 3 - 128

Example:

"Shoes"

cashOnDeliveryRequestCents

number

required

The amount to be collected on delivery in cents.

Required range: x >= 0

Example:

8900000

offers

object[]

required

An array of offers from courier services.

Show child attributes

offers.courier

string

required

The name of the courier service.

Example:

"couriers/coordinadora"

offers.status

enum<string>

required

The status of the offer.

Available options:

SUCCESS,

PENDING,

FAILED

offers.shipmentCostCents

number

required

The cost of the shipment in cents.

Example:

1430000

offers.returnShipmentCostCents

number

required

The cost of returning the package in cents.

Example:

930000

offers.deliveryMinutes

number

required

The minutes of delivery.

Example:

1400

order

string | null

The unique identifier for the order associated with the shipment.

Example:

"orders/66d86d4b05a7d437ac6c5379"

List Locations Get Quote

⌘I

Guías

Shipping

Authorizations

Body

Response