curl --request GET \
--url https://api.orbita.melonn.com/courier-companies \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbita.melonn.com/courier-companies"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbita.melonn.com/courier-companies', 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.orbita.melonn.com/courier-companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbita.melonn.com/courier-companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orbita.melonn.com/courier-companies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbita.melonn.com/courier-companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": 3,
"name": "TCC",
"code": "TCC"
},
{
"id": 7,
"name": "Servientrega",
"code": "SERVIENTREGA"
},
{
"id": 12,
"name": "Coordinadora",
"code": "COORDINADORA"
}
]Get all
Returns the catalog of courier companies (carriers) that operate with Melonn warehouses.
What the ids are for
The id of a courier company is the value you send in courier_company_id when you
create a supplier order: it tells Melonn which carrier is bringing
your inventory to the destination warehouse, so the reception team can identify the shipment
when it arrives. The field is optional on supplier orders.
To get the carriers that can deliver inbound shipments to a specific warehouse, call this
endpoint with warehouse_code set to the supplier order’s destination_warehouse_code and
inbound=true.
How the filters combine
- A courier company is returned when it has an active configuration in at least one
warehouse that matches all the filters you send (
warehouse_code,inbound,outbound). - If you send neither
inboundnoroutbound, both are applied astrue: only couriers that are active for inbound and outbound service in the same warehouse are returned. - If you send only one of them, the other one is not filtered.
inboundandoutboundonly accepttrue. Sendingfalsereturns400.courier_company_codenarrows the result to a single courier.
The catalog is the same for every seller. An unknown warehouse_code or
courier_company_code returns an empty array, not an error. The order of the results is not
guaranteed.
curl --request GET \
--url https://api.orbita.melonn.com/courier-companies \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbita.melonn.com/courier-companies"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbita.melonn.com/courier-companies', 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.orbita.melonn.com/courier-companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbita.melonn.com/courier-companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orbita.melonn.com/courier-companies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbita.melonn.com/courier-companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": 3,
"name": "TCC",
"code": "TCC"
},
{
"id": 7,
"name": "Servientrega",
"code": "SERVIENTREGA"
},
{
"id": 12,
"name": "Coordinadora",
"code": "COORDINADORA"
}
]Authorizations
Query Parameters
Code of the warehouse (CEDI). Only couriers configured for this warehouse are returned.
Code of a courier company. Returns only that courier (if it matches the other filters).
Only couriers active for inbound service (delivering inventory to the warehouse). Only
true is accepted. See "How the filters combine" for the default when omitted.
true Only couriers active for outbound service (delivering orders from the warehouse to buyers).
Only true is accepted. See "How the filters combine" for the default when omitted.
true Response
List of courier companies matching the filters (can be empty).