Orders

Method	Endpoint	Description
GET	`/orders`	List orders
POST	`/orders`	Create order
GET	`/orders/{orderId}`	Get order
DELETE	`/orders/{orderId}`	Cancel order
PATCH	`/orders/{orderId}`	Update order status or metadata

Parameters

Query

status string

query

Allowed: draftpendingpaidshippedcancelledrefunded

customer_id string

query

page integer

query

Default: 1

200 Paginated orders

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

BASH

curl -X GET "https://api.example.com/orders" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/orders"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

response = requests.get(url, headers=headers)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders";

const options = {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/orders"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('GET', $url, $options);

echo $response->getBody();

Request Body

requiredapplication/json

items array

Items:

items items object

page integer

total integer

201 Order created

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

400 Validation failed

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

BASH

curl -X POST "https://api.example.com/orders" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "string",
  "line_items": [
    {
      "sku": "string",
      "name": "string",
      "quantity": 1,
      "unit_price": {
        "currency": "USD",
        "amount": 1
      },
      "total": {
        "currency": "USD",
        "amount": 1
      }
    }
  ],
  "shipping_address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string"
  },
  "billing_address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string"
  }
}'

python

PYTHON

import requests

url = "https://api.example.com/orders"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "customer_id": "string",
    "line_items": [
        {
            "sku": "string",
            "name": "string",
            "quantity": 1,
            "unit_price": {
                "currency": "USD",
                "amount": 1
            },
            "total": {
                "currency": "USD",
                "amount": 1
            }
        }
    ],
    "shipping_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
    },
    "billing_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
    }
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders";

const options = {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customer_id": "string",
    "line_items": [
        {
            "sku": "string",
            "name": "string",
            "quantity": 1,
            "unit_price": {
                "currency": "USD",
                "amount": 1
            },
            "total": {
                "currency": "USD",
                "amount": 1
            }
        }
    ],
    "shipping_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
    },
    "billing_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
    }
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/orders"

	body := []byte(`{"customer_id": "string", "line_items": [{"sku": "string", "name": "string", "quantity": 1, "unit_price": {"currency": "USD", "amount": 1}, "total": {"currency": "USD", "amount": 1}}], "shipping_address": {"line1": "string", "line2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string"}, "billing_address": {"line1": "string", "line2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string"}}`)
	req, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "customer_id": "string",\n  "line_items": [\n    {\n      "sku": "string",\n      "name": "string",\n      "quantity": 1,\n      "unit_price": {\n        "currency": "USD",\n        "amount": 1\n      },\n      "total": {\n        "currency": "USD",\n        "amount": 1\n      }\n    }\n  ],\n  "shipping_address": {\n    "line1": "string",\n    "line2": "string",\n    "city": "string",\n    "state": "string",\n    "postal_code": "string",\n    "country": "string"\n  },\n  "billing_address": {\n    "line1": "string",\n    "line2": "string",\n    "city": "string",\n    "state": "string",\n    "postal_code": "string",\n    "country": "string"\n  }\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['customer_id' => 'string', 'line_items' => [['sku' => 'string', 'name' => 'string', 'quantity' => 1, 'unit_price' => ['currency' => 'USD', 'amount' => 1], 'total' => ['currency' => 'USD', 'amount' => 1]]], 'shipping_address' => ['line1' => 'string', 'line2' => 'string', 'city' => 'string', 'state' => 'string', 'postal_code' => 'string', 'country' => 'string'], 'billing_address' => ['line1' => 'string', 'line2' => 'string', 'city' => 'string', 'state' => 'string', 'postal_code' => 'string', 'country' => 'string']],
];

$response = $client->request('POST', $url, $options);

echo $response->getBody();

Parameters

Path

orderId string

requiredpath

200 Order details

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

404 Resource not found

Content-Type: application/json

BASH

curl -X GET "https://api.example.com/orders/id_123" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/orders/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

response = requests.get(url, headers=headers)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders/id_123";

const options = {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/orders/id_123"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('GET', $url, $options);

echo $response->getBody();

Parameters

Path

orderId string

requiredpath

204 Order cancelled

Content-Type: application/json

404 Resource not found

Content-Type: application/json

BASH

curl -X DELETE "https://api.example.com/orders/id_123" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/orders/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

response = requests.delete(url, headers=headers)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders/id_123";

const options = {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/orders/id_123"

	req, err := http.NewRequest("DELETE", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('DELETE', $url, $options);

echo $response->getBody();

Parameters

Path

orderId string

requiredpath

Request Body

requiredapplication/json

items array

Items:

items items object

page integer

total integer

200 Updated order

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

400 Validation failed

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

404 Resource not found

Content-Type: application/json

BASH

curl -X PATCH "https://api.example.com/orders/id_123" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "draft",
  "metadata": {}
}'

python

PYTHON

import requests

url = "https://api.example.com/orders/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "status": "draft",
    "metadata": {}
}

response = requests.patch(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders/id_123";

const options = {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "draft",
    "metadata": {}
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/orders/id_123"

	body := []byte(`{"status": "draft", "metadata": {}}`)
	req, err := http.NewRequest("PATCH", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "status": "draft",\n  "metadata": {}\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['status' => 'draft', 'metadata' => []],
];

$response = $client->request('PATCH', $url, $options);

echo $response->getBody();

Endpoints

List orders

Parameters

Query

Responses

Create order

Request Body

Responses

Get order

Parameters

Path

Responses

Cancel order

Parameters

Path

Responses

Update order status or metadata

Parameters

Path

Request Body

Responses

Endpoints

Parameters

Filter Query

Parameters

Link Path

Parameters

Link Path

Parameters

Link Path

Query

Path

Path

Path