cURL
curl --request POST \
--url https://api.goevery.co/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "NEW",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": [
"Calle 123",
"Apto 2"
],
"organization": "<string>"
},
"location": "locations/CO-11001000",
"documentType": "CC",
"document": "1040777098"
},
"contentDescription": "Shoes",
"notes": "1 Pair of Reebok Nano, Size 8, Color Black",
"sellingPriceCents": 1430000,
"cashOnDeliveryRequestCents": 8900000,
"paymentMethods": [
"Cash On Delivery (COD)",
"Credit Card"
],
"referenceId": "1234567890",
"referenceUrl": "https://mystore.com/order/1234567890",
"fulfiller": "every"
}
'import requests
url = "https://api.goevery.co/v1/orders"
payload = {
"status": "NEW",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": ["Calle 123", "Apto 2"],
"organization": "<string>"
},
"location": "locations/CO-11001000",
"documentType": "CC",
"document": "1040777098"
},
"contentDescription": "Shoes",
"notes": "1 Pair of Reebok Nano, Size 8, Color Black",
"sellingPriceCents": 1430000,
"cashOnDeliveryRequestCents": 8900000,
"paymentMethods": ["Cash On Delivery (COD)", "Credit Card"],
"referenceId": "1234567890",
"referenceUrl": "https://mystore.com/order/1234567890",
"fulfiller": "every"
}
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({
status: 'NEW',
recipient: {
firstName: 'Valentina',
lastName: 'Rodríguez López',
email: 'valentina@gmail.com',
phoneNumber: '+573193210329',
address: {addressLines: ['Calle 123', 'Apto 2'], organization: '<string>'},
location: 'locations/CO-11001000',
documentType: 'CC',
document: '1040777098'
},
contentDescription: 'Shoes',
notes: '1 Pair of Reebok Nano, Size 8, Color Black',
sellingPriceCents: 1430000,
cashOnDeliveryRequestCents: 8900000,
paymentMethods: ['Cash On Delivery (COD)', 'Credit Card'],
referenceId: '1234567890',
referenceUrl: 'https://mystore.com/order/1234567890',
fulfiller: 'every'
})
};
fetch('https://api.goevery.co/v1/orders', 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/orders",
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([
'status' => 'NEW',
'recipient' => [
'firstName' => 'Valentina',
'lastName' => 'Rodríguez López',
'email' => 'valentina@gmail.com',
'phoneNumber' => '+573193210329',
'address' => [
'addressLines' => [
'Calle 123',
'Apto 2'
],
'organization' => '<string>'
],
'location' => 'locations/CO-11001000',
'documentType' => 'CC',
'document' => '1040777098'
],
'contentDescription' => 'Shoes',
'notes' => '1 Pair of Reebok Nano, Size 8, Color Black',
'sellingPriceCents' => 1430000,
'cashOnDeliveryRequestCents' => 8900000,
'paymentMethods' => [
'Cash On Delivery (COD)',
'Credit Card'
],
'referenceId' => '1234567890',
'referenceUrl' => 'https://mystore.com/order/1234567890',
'fulfiller' => 'every'
]),
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/orders"
payload := strings.NewReader("{\n \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\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/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goevery.co/v1/orders")
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 \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\n}"
response = http.request(request)
puts response.read_body{
"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": "valentina@gmail.com",
"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"
},
"fulfiller": "every",
"shipment": "shipments/669986bb4ae1239d5a92cdff",
"referenceId": "4012",
"referenceGid": "93240958723",
"referenceUrl": "https://mystore.com/order/1234567890",
"paymentMethods": [
"Cash On Delivery (COD)",
"Credit Card"
]
}Shipping
Create Order
POST
/
v1
/
orders
cURL
curl --request POST \
--url https://api.goevery.co/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "NEW",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": [
"Calle 123",
"Apto 2"
],
"organization": "<string>"
},
"location": "locations/CO-11001000",
"documentType": "CC",
"document": "1040777098"
},
"contentDescription": "Shoes",
"notes": "1 Pair of Reebok Nano, Size 8, Color Black",
"sellingPriceCents": 1430000,
"cashOnDeliveryRequestCents": 8900000,
"paymentMethods": [
"Cash On Delivery (COD)",
"Credit Card"
],
"referenceId": "1234567890",
"referenceUrl": "https://mystore.com/order/1234567890",
"fulfiller": "every"
}
'import requests
url = "https://api.goevery.co/v1/orders"
payload = {
"status": "NEW",
"recipient": {
"firstName": "Valentina",
"lastName": "Rodríguez López",
"email": "valentina@gmail.com",
"phoneNumber": "+573193210329",
"address": {
"addressLines": ["Calle 123", "Apto 2"],
"organization": "<string>"
},
"location": "locations/CO-11001000",
"documentType": "CC",
"document": "1040777098"
},
"contentDescription": "Shoes",
"notes": "1 Pair of Reebok Nano, Size 8, Color Black",
"sellingPriceCents": 1430000,
"cashOnDeliveryRequestCents": 8900000,
"paymentMethods": ["Cash On Delivery (COD)", "Credit Card"],
"referenceId": "1234567890",
"referenceUrl": "https://mystore.com/order/1234567890",
"fulfiller": "every"
}
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({
status: 'NEW',
recipient: {
firstName: 'Valentina',
lastName: 'Rodríguez López',
email: 'valentina@gmail.com',
phoneNumber: '+573193210329',
address: {addressLines: ['Calle 123', 'Apto 2'], organization: '<string>'},
location: 'locations/CO-11001000',
documentType: 'CC',
document: '1040777098'
},
contentDescription: 'Shoes',
notes: '1 Pair of Reebok Nano, Size 8, Color Black',
sellingPriceCents: 1430000,
cashOnDeliveryRequestCents: 8900000,
paymentMethods: ['Cash On Delivery (COD)', 'Credit Card'],
referenceId: '1234567890',
referenceUrl: 'https://mystore.com/order/1234567890',
fulfiller: 'every'
})
};
fetch('https://api.goevery.co/v1/orders', 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/orders",
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([
'status' => 'NEW',
'recipient' => [
'firstName' => 'Valentina',
'lastName' => 'Rodríguez López',
'email' => 'valentina@gmail.com',
'phoneNumber' => '+573193210329',
'address' => [
'addressLines' => [
'Calle 123',
'Apto 2'
],
'organization' => '<string>'
],
'location' => 'locations/CO-11001000',
'documentType' => 'CC',
'document' => '1040777098'
],
'contentDescription' => 'Shoes',
'notes' => '1 Pair of Reebok Nano, Size 8, Color Black',
'sellingPriceCents' => 1430000,
'cashOnDeliveryRequestCents' => 8900000,
'paymentMethods' => [
'Cash On Delivery (COD)',
'Credit Card'
],
'referenceId' => '1234567890',
'referenceUrl' => 'https://mystore.com/order/1234567890',
'fulfiller' => 'every'
]),
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/orders"
payload := strings.NewReader("{\n \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\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/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goevery.co/v1/orders")
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 \"status\": \"NEW\",\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 \"location\": \"locations/CO-11001000\",\n \"documentType\": \"CC\",\n \"document\": \"1040777098\"\n },\n \"contentDescription\": \"Shoes\",\n \"notes\": \"1 Pair of Reebok Nano, Size 8, Color Black\",\n \"sellingPriceCents\": 1430000,\n \"cashOnDeliveryRequestCents\": 8900000,\n \"paymentMethods\": [\n \"Cash On Delivery (COD)\",\n \"Credit Card\"\n ],\n \"referenceId\": \"1234567890\",\n \"referenceUrl\": \"https://mystore.com/order/1234567890\",\n \"fulfiller\": \"every\"\n}"
response = http.request(request)
puts response.read_body{
"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": "valentina@gmail.com",
"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"
},
"fulfiller": "every",
"shipment": "shipments/669986bb4ae1239d5a92cdff",
"referenceId": "4012",
"referenceGid": "93240958723",
"referenceUrl": "https://mystore.com/order/1234567890",
"paymentMethods": [
"Cash On Delivery (COD)",
"Credit Card"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The initial status of the order.
Available options:
NEW, CONFIRMED Example:
"NEW"
Details of the recipient of the order.
Show child attributes
Show child attributes
A very short description of the package content.
Required string length:
3 - 128Example:
"Shoes"
A detailed description of the contents of this package and additional information.
Required string length:
3 - 2048Example:
"1 Pair of Reebok Nano, Size 8, Color Black"
The order selling price, just for reporting purposes.
Example:
1430000
The amount to be collected on delivery in cents.
Required range:
x >= 0Example:
8900000
Payment methods used for this order.
Example:
["Cash On Delivery (COD)", "Credit Card"]
The ID of the order in the external system that created it, like Shopify order ID.
Example:
"1234567890"
The URL to the order in the external system, like Shopify order URL.
Example:
"https://mystore.com/order/1234567890"
The entity responsible for fulfilling (shipping) the order. Defaults to 'every' if not provided.
Available options:
every, dropi Example:
"every"
Response
200 - application/json
Successfully created a order.
The unique identifier of the order.
Example:
"orders/669a8cba6af86466a42de2fe"
The timestamp when the order was created.
Example:
"2024-07-17T21:32:52.478Z"
The timestamp when the order was last updated.
Example:
"2024-07-17T21:32:52.478Z"
The current status of the order.
Available options:
NEW, CONFIRMED, READY, IN_PROGRESS, CANCELLED, DELIVERED, RETURN Example:
"NEW"
Details of the recipient of the order.
Show child attributes
Show child attributes
A description of the package content.
Required string length:
3 - 128Example:
"Shoes"
A detailed description of the contents of this package and additional information.
Required string length:
3 - 2048Example:
"1 Pair of Reebok Nano, Size 8, Color Black"
The order selling price, just for reporting purposes.
Example:
1430000
The amount to be collected on delivery in cents.
Required range:
x >= 0Example:
8900000
The reliability of the customer.
Available options:
RELIABLE, MODERATE, UNRELIABLE, NO_ORDERS Example:
"RELIABLE"
Show child attributes
Show child attributes
The entity responsible for fulfilling (shipping) the order.
Example:
"every"
The unique identifier for the associated shipment.
Example:
"shipments/669986bb4ae1239d5a92cdff"
The ID of the order in the external system that created it, like Shopify order name.
Example:
"4012"
The global identifier of the order in the external system, like Shopify order GID.
Example:
"93240958723"
The URL to the order in the external system, like Shopify order URL.
Example:
"https://mystore.com/order/1234567890"
Payment methods used for this order.
Example:
["Cash On Delivery (COD)", "Credit Card"]