cURL
curl --request POST \
--url https://api.goevery.co/v1/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quote": "quotes/669986bb4ae1239d5a92cdff",
"courier": "couriers/coordinadora",
"origin": "origins/66343b5ac38abe08414dc303",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": [
"Calle 123",
"Apto 2"
],
"organization": "<string>"
},
"documentType": "CC",
"document": "1040777098"
},
"requiresPickup": true
}
'import requests
url = "https://api.goevery.co/v1/shipments"
payload = {
"quote": "quotes/669986bb4ae1239d5a92cdff",
"courier": "couriers/coordinadora",
"origin": "origins/66343b5ac38abe08414dc303",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": ["Calle 123", "Apto 2"],
"organization": "<string>"
},
"documentType": "CC",
"document": "1040777098"
},
"requiresPickup": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quote: 'quotes/669986bb4ae1239d5a92cdff',
courier: 'couriers/coordinadora',
origin: 'origins/66343b5ac38abe08414dc303',
recipient: {
firstName: 'Valentina',
lastName: 'Rodríguez López',
email: 'valentina@gmail.com',
phoneNumber: '+573193210329',
address: {addressLines: ['Calle 123', 'Apto 2'], organization: '<string>'},
documentType: 'CC',
document: '1040777098'
},
requiresPickup: true
})
};
fetch('https://api.goevery.co/v1/shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goevery.co/v1/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quote' => 'quotes/669986bb4ae1239d5a92cdff',
'courier' => 'couriers/coordinadora',
'origin' => 'origins/66343b5ac38abe08414dc303',
'recipient' => [
'firstName' => 'Valentina',
'lastName' => 'Rodríguez López',
'email' => 'valentina@gmail.com',
'phoneNumber' => '+573193210329',
'address' => [
'addressLines' => [
'Calle 123',
'Apto 2'
],
'organization' => '<string>'
],
'documentType' => 'CC',
'document' => '1040777098'
],
'requiresPickup' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goevery.co/v1/shipments"
payload := strings.NewReader("{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.goevery.co/v1/shipments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goevery.co/v1/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}"
response = http.request(request)
puts response.read_body{
"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=..."
}Shipping
Create Shipment
POST
/
v1
/
shipments
cURL
curl --request POST \
--url https://api.goevery.co/v1/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quote": "quotes/669986bb4ae1239d5a92cdff",
"courier": "couriers/coordinadora",
"origin": "origins/66343b5ac38abe08414dc303",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": [
"Calle 123",
"Apto 2"
],
"organization": "<string>"
},
"documentType": "CC",
"document": "1040777098"
},
"requiresPickup": true
}
'import requests
url = "https://api.goevery.co/v1/shipments"
payload = {
"quote": "quotes/669986bb4ae1239d5a92cdff",
"courier": "couriers/coordinadora",
"origin": "origins/66343b5ac38abe08414dc303",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": ["Calle 123", "Apto 2"],
"organization": "<string>"
},
"documentType": "CC",
"document": "1040777098"
},
"requiresPickup": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quote: 'quotes/669986bb4ae1239d5a92cdff',
courier: 'couriers/coordinadora',
origin: 'origins/66343b5ac38abe08414dc303',
recipient: {
firstName: 'Valentina',
lastName: 'Rodríguez López',
email: 'valentina@gmail.com',
phoneNumber: '+573193210329',
address: {addressLines: ['Calle 123', 'Apto 2'], organization: '<string>'},
documentType: 'CC',
document: '1040777098'
},
requiresPickup: true
})
};
fetch('https://api.goevery.co/v1/shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goevery.co/v1/shipments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'quote' => 'quotes/669986bb4ae1239d5a92cdff',
'courier' => 'couriers/coordinadora',
'origin' => 'origins/66343b5ac38abe08414dc303',
'recipient' => [
'firstName' => 'Valentina',
'lastName' => 'Rodríguez López',
'email' => 'valentina@gmail.com',
'phoneNumber' => '+573193210329',
'address' => [
'addressLines' => [
'Calle 123',
'Apto 2'
],
'organization' => '<string>'
],
'documentType' => 'CC',
'document' => '1040777098'
],
'requiresPickup' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goevery.co/v1/shipments"
payload := strings.NewReader("{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.goevery.co/v1/shipments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goevery.co/v1/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quote\": \"quotes/669986bb4ae1239d5a92cdff\",\n \"courier\": \"couriers/coordinadora\",\n \"origin\": \"origins/66343b5ac38abe08414dc303\",\n \"recipient\": {\n \"firstName\": \"Valentina\",\n \"lastName\": \"Rodríguez López\",\n \"email\": \"valentina@gmail.com\",\n \"phoneNumber\": \"+573193210329\",\n \"address\": {\n \"addressLines\": [\n \"Calle 123\",\n \"Apto 2\"\n ],\n \"organization\": \"<string>\"\n },\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"requiresPickup\": true\n}"
response = http.request(request)
puts response.read_body{
"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=..."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The unique identifier for the accepted quote.
Example:
"quotes/669986bb4ae1239d5a92cdff"
The name of the courier service handling the shipment.
Example:
"couriers/coordinadora"
The resource name of the selected origin location.
Example:
"origins/66343b5ac38abe08414dc303"
Details of the recipient of the shipment.
Show child attributes
Show child attributes
Indicates whether the shipment requires pickup by the courier.
Response
200 - application/json
Successfully created a shipment.
The unique identifier of the shipment.
Example:
"shipments/669a8cba6af86466a42de2fe"
The timestamp when the shipment was created.
Example:
"2024-07-17T21:32:52.478Z"
The timestamp when the shipment was last updated.
Example:
"2024-07-17T21:32:52.478Z"
The unique identifier for the accepted quote.
Example:
"quotes/669986bb4ae1239d5a92cdff"
The name of the courier service handling the shipment.
Example:
"couriers/coordinadora"
The resource name of the selected origin location.
Example:
"origins/66343b5ac38abe08414dc303"
Details of the recipient of the shipment.
Show child attributes
Show child attributes
Indicates whether the shipment requires pickup by the courier.
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"
The cost of the shipment in cents (COP).
Example:
1700000
The cash on delivery service cost in cents (COP).
Example:
350000
The total cost of the shipment including all fees in cents (COP).
Example:
2050000
The label identifier for the shipment.
Example:
"240013993254"
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=..."