curl --request GET \
--url https://api.cubbo.com/v1/orders/with-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cubbo.com/v1/orders/with-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cubbo.com/v1/orders/with-fields', 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.cubbo.com/v1/orders/with-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.cubbo.com/v1/orders/with-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cubbo.com/v1/orders/with-fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cubbo.com/v1/orders/with-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": 987654,
"order_number": "ORD-0001",
"status": "shipped",
"shipping_status": "shipment_delivered",
"delivery_tracking": [
{
"shipping_number": "TRK000000001",
"tracking_url": "https://carrier.example.com/track/TRK000000001",
"cubbo_tracking_url": "https://tracking.example.com/orders/abc123",
"service_id": "express",
"shipping_status": "shipment_delivered",
"package_index": 1,
"total_packages": 1
}
]
}
],
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"first_page": true,
"last_page": true,
"per_page": 100,
"total_count": 1
}
}List orders with selected fields
A lighter version of GET /orders: returns only the order fields you ask for in fields, without
order lines, invoices or event history. Use it for high-volume polling (for example status or
tracking sync) where you do not need the full payload.
fieldsis a list ofOrderfield names. Values that are not in the allowed list are ignored; if none of the requested fields is valid, orfieldsis omitted, every allowed field is returned.- Allowed fields:
id,store_id,order_number,status,channel_created_at,order_date,shipping_date,pending_at,shipping_email,shipping_status,is_paid,channel_order_id,channel_name,is_cod,cod_amount,has_carrier_insurance,requires_document_return,requires_pickup_on_delivery,currency,total_price,shipping,billing,estimated_time_arrival,delivered_at,updated_at,is_click_and_collect,click_and_collect_metadata,channel_shipping_line_code,warehouse_timezone,shipping_method,is_multi_package,delivery_tracking,is_first_time_buyer,is_subscription_renewal. shipping_methodis the only association available; when requested it is returned with everyOrderShippingMethodfield.- Filters:
status(exact values, noprocessingexpansion),order_type,shipping_email(partial match) andnormalized_shipping_phone_suffix(the last digits of the buyer’s phone, at least 3 digits after removing non-digits). - Sorting is restricted to
sort_byinid,order_date,channel_created_at,shipping_date,updated_atandsortinasc,desc.
curl --request GET \
--url https://api.cubbo.com/v1/orders/with-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cubbo.com/v1/orders/with-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cubbo.com/v1/orders/with-fields', 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.cubbo.com/v1/orders/with-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.cubbo.com/v1/orders/with-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cubbo.com/v1/orders/with-fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cubbo.com/v1/orders/with-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": 987654,
"order_number": "ORD-0001",
"status": "shipped",
"shipping_status": "shipment_delivered",
"delivery_tracking": [
{
"shipping_number": "TRK000000001",
"tracking_url": "https://carrier.example.com/track/TRK000000001",
"cubbo_tracking_url": "https://tracking.example.com/orders/abc123",
"service_id": "express",
"shipping_status": "shipment_delivered",
"package_index": 1,
"total_packages": 1
}
]
}
],
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"first_page": true,
"last_page": true,
"per_page": 100,
"total_count": 1
}
}Authorizations
Query Parameters
Fields to include in each order. Unknown values are ignored; omit to receive all allowed fields.
id, store_id, order_number, status, channel_created_at, order_date, shipping_date, pending_at, shipping_email, shipping_status, is_paid, channel_order_id, channel_name, is_cod, cod_amount, has_carrier_insurance, requires_document_return, requires_pickup_on_delivery, currency, total_price, shipping, billing, estimated_time_arrival, delivered_at, updated_at, is_click_and_collect, click_and_collect_metadata, channel_shipping_line_code, warehouse_timezone, shipping_method, is_multi_package, delivery_tracking, is_first_time_buyer, is_subscription_renewal Only return orders in these statuses. Values outside the enum return 422.
Fulfillment status of an order. processing, picking and packing all mean the order is being
prepared in the warehouse. holded means the order is on hold. packed is unused.
initial, unpaid, empty, pending, error, cancelation_window, entirely_dropshipping, backorder, processing, picking, packing, packed, shipped, canceled, holded, interrupted, returned, return_arrived, returning, reentered, awaiting_fulfillment_request, awaiting_dropoff, arrived_at_warehouse Only return orders of these types. Values outside the enum return 422.
Kind of order. SALE is a regular sale; DONATION ships goods without a sale; REMOVE_STOCK,
REMOVE_DAMAGED_STOCK, REMOVE_EXPIRED_STOCK and REMOVE_LOST_STOCK withdraw stock from the
warehouse; STOCK_TRANSFER_OUT moves stock to another store; C2C is a consumer-to-consumer
shipment created by Cubbo and cannot be created through the API.
SALE, DONATION, REMOVE_STOCK, REMOVE_DAMAGED_STOCK, REMOVE_EXPIRED_STOCK, REMOVE_LOST_STOCK, STOCK_TRANSFER_OUT, C2C