List orders
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/orders"
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.bitbybit.studio/customer/api/open/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.bitbybit.studio/customer/api/open/v1/orders",
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.bitbybit.studio/customer/api/open/v1/orders"
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.bitbybit.studio/customer/api/open/v1/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/orders")
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{
"data": [
{
"id": "<string>",
"orderId": "<string>",
"orderNumber": "<string>",
"total": 123,
"currency": "<string>",
"notes": "<string>",
"customer": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>"
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"title": "<string>",
"productVariant": {
"id": "<string>",
"key": "<string>",
"price": 123,
"compareAtPrice": 123,
"inventorySku": "<string>",
"media": "<string>"
}
}
],
"shippingAddress": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>"
},
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"page": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}
}Orders
List Orders
Retrieve a paginated list of orders for your company.
GET
/
orders
List orders
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/orders"
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.bitbybit.studio/customer/api/open/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.bitbybit.studio/customer/api/open/v1/orders",
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.bitbybit.studio/customer/api/open/v1/orders"
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.bitbybit.studio/customer/api/open/v1/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/orders")
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{
"data": [
{
"id": "<string>",
"orderId": "<string>",
"orderNumber": "<string>",
"total": 123,
"currency": "<string>",
"notes": "<string>",
"customer": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>"
},
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"title": "<string>",
"productVariant": {
"id": "<string>",
"key": "<string>",
"price": 123,
"compareAtPrice": 123,
"inventorySku": "<string>",
"media": "<string>"
}
}
],
"shippingAddress": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>"
},
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"page": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}
}Authorizations
API key for authentication. Create one in Settings > Developer.
Query Parameters
Required range:
x <= 100Search by order ID or customer name
Available options:
active, archived, cancelled, refunded Available options:
unfulfilled, fulfilled ⌘I

