Create external order
curl --request POST \
--url https://api.fourthwall.com/open-api/v1.0/external-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"items": [
{
"variantId": "c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q",
"quantity": 2,
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"billingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"customerEmail": "customer@example.com",
"metadata": {},
"taxOverride": "SKIP",
"taxOverrideReason": "Customer is the merchant of record (resale)"
}
'import requests
url = "https://api.fourthwall.com/open-api/v1.0/external-orders"
payload = {
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"items": [
{
"variantId": "c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q",
"quantity": 2,
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"billingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"customerEmail": "customer@example.com",
"metadata": {},
"taxOverride": "SKIP",
"taxOverrideReason": "Customer is the merchant of record (resale)"
}
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({
externalOrderId: 'ETSY-123456789',
externalSource: 'ETSY',
items: [
{
variantId: 'c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q',
quantity: 2,
externalLineItemId: 'etsy-line-item-123'
}
],
shippingAddress: {
firstName: 'John',
lastName: 'Doe',
address1: '123 Main Street',
city: 'San Francisco',
zip: '94105',
country: 'US',
address2: 'Apt 4B',
state: 'CA',
phone: '+1-555-123-4567'
},
billingAddress: {
firstName: 'John',
lastName: 'Doe',
address1: '123 Main Street',
city: 'San Francisco',
zip: '94105',
country: 'US',
address2: 'Apt 4B',
state: 'CA',
phone: '+1-555-123-4567'
},
customerEmail: 'customer@example.com',
metadata: {},
taxOverride: 'SKIP',
taxOverrideReason: 'Customer is the merchant of record (resale)'
})
};
fetch('https://api.fourthwall.com/open-api/v1.0/external-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.fourthwall.com/open-api/v1.0/external-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([
'externalOrderId' => 'ETSY-123456789',
'externalSource' => 'ETSY',
'items' => [
[
'variantId' => 'c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q',
'quantity' => 2,
'externalLineItemId' => 'etsy-line-item-123'
]
],
'shippingAddress' => [
'firstName' => 'John',
'lastName' => 'Doe',
'address1' => '123 Main Street',
'city' => 'San Francisco',
'zip' => '94105',
'country' => 'US',
'address2' => 'Apt 4B',
'state' => 'CA',
'phone' => '+1-555-123-4567'
],
'billingAddress' => [
'firstName' => 'John',
'lastName' => 'Doe',
'address1' => '123 Main Street',
'city' => 'San Francisco',
'zip' => '94105',
'country' => 'US',
'address2' => 'Apt 4B',
'state' => 'CA',
'phone' => '+1-555-123-4567'
],
'customerEmail' => 'customer@example.com',
'metadata' => [
],
'taxOverride' => 'SKIP',
'taxOverrideReason' => 'Customer is the merchant of record (resale)'
]),
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.fourthwall.com/open-api/v1.0/external-orders"
payload := strings.NewReader("{\n \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\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.fourthwall.com/open-api/v1.0/external-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fourthwall.com/open-api/v1.0/external-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 \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\n}"
response = http.request(request)
puts response.read_body{
"orderId": "b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"friendlyId": "T4YTE8HA",
"status": "CONFIRMED",
"items": [
{
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 2,
"unitCost": {
"value": 10,
"currency": "USD"
},
"totalCost": {
"value": 10,
"currency": "USD"
},
"itemFulfillmentFee": {
"value": 10,
"currency": "USD"
},
"itemShippingCost": {
"value": 10,
"currency": "USD"
},
"itemTotalCreatorCost": {
"value": 10,
"currency": "USD"
},
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"costs": {
"fulfillmentFee": {
"value": 10,
"currency": "USD"
},
"manufacturingCost": {
"value": 10,
"currency": "USD"
},
"shippingCost": {
"value": 10,
"currency": "USD"
},
"totalCreatorCost": {
"value": 10,
"currency": "USD"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Create External Order
Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.
Create an externally-paid order for fulfillment. This creates an order where payment was processed on an external marketplace (e.g., Etsy, Amazon) and Fourthwall handles fulfillment. The creator will be charged for fulfillment costs.
POST
/
open-api
/
v1.0
/
external-orders
Create external order
curl --request POST \
--url https://api.fourthwall.com/open-api/v1.0/external-orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"items": [
{
"variantId": "c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q",
"quantity": 2,
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"billingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"customerEmail": "customer@example.com",
"metadata": {},
"taxOverride": "SKIP",
"taxOverrideReason": "Customer is the merchant of record (resale)"
}
'import requests
url = "https://api.fourthwall.com/open-api/v1.0/external-orders"
payload = {
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"items": [
{
"variantId": "c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q",
"quantity": 2,
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"billingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"customerEmail": "customer@example.com",
"metadata": {},
"taxOverride": "SKIP",
"taxOverrideReason": "Customer is the merchant of record (resale)"
}
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({
externalOrderId: 'ETSY-123456789',
externalSource: 'ETSY',
items: [
{
variantId: 'c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q',
quantity: 2,
externalLineItemId: 'etsy-line-item-123'
}
],
shippingAddress: {
firstName: 'John',
lastName: 'Doe',
address1: '123 Main Street',
city: 'San Francisco',
zip: '94105',
country: 'US',
address2: 'Apt 4B',
state: 'CA',
phone: '+1-555-123-4567'
},
billingAddress: {
firstName: 'John',
lastName: 'Doe',
address1: '123 Main Street',
city: 'San Francisco',
zip: '94105',
country: 'US',
address2: 'Apt 4B',
state: 'CA',
phone: '+1-555-123-4567'
},
customerEmail: 'customer@example.com',
metadata: {},
taxOverride: 'SKIP',
taxOverrideReason: 'Customer is the merchant of record (resale)'
})
};
fetch('https://api.fourthwall.com/open-api/v1.0/external-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.fourthwall.com/open-api/v1.0/external-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([
'externalOrderId' => 'ETSY-123456789',
'externalSource' => 'ETSY',
'items' => [
[
'variantId' => 'c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q',
'quantity' => 2,
'externalLineItemId' => 'etsy-line-item-123'
]
],
'shippingAddress' => [
'firstName' => 'John',
'lastName' => 'Doe',
'address1' => '123 Main Street',
'city' => 'San Francisco',
'zip' => '94105',
'country' => 'US',
'address2' => 'Apt 4B',
'state' => 'CA',
'phone' => '+1-555-123-4567'
],
'billingAddress' => [
'firstName' => 'John',
'lastName' => 'Doe',
'address1' => '123 Main Street',
'city' => 'San Francisco',
'zip' => '94105',
'country' => 'US',
'address2' => 'Apt 4B',
'state' => 'CA',
'phone' => '+1-555-123-4567'
],
'customerEmail' => 'customer@example.com',
'metadata' => [
],
'taxOverride' => 'SKIP',
'taxOverrideReason' => 'Customer is the merchant of record (resale)'
]),
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.fourthwall.com/open-api/v1.0/external-orders"
payload := strings.NewReader("{\n \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\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.fourthwall.com/open-api/v1.0/external-orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fourthwall.com/open-api/v1.0/external-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 \"externalOrderId\": \"ETSY-123456789\",\n \"externalSource\": \"ETSY\",\n \"items\": [\n {\n \"variantId\": \"c2b6d0e3-4f5g-6h7i-8j9k-0l1m2n3o4p5q\",\n \"quantity\": 2,\n \"externalLineItemId\": \"etsy-line-item-123\"\n }\n ],\n \"shippingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main Street\",\n \"city\": \"San Francisco\",\n \"zip\": \"94105\",\n \"country\": \"US\",\n \"address2\": \"Apt 4B\",\n \"state\": \"CA\",\n \"phone\": \"+1-555-123-4567\"\n },\n \"customerEmail\": \"customer@example.com\",\n \"metadata\": {},\n \"taxOverride\": \"SKIP\",\n \"taxOverrideReason\": \"Customer is the merchant of record (resale)\"\n}"
response = http.request(request)
puts response.read_body{
"orderId": "b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
"externalOrderId": "ETSY-123456789",
"externalSource": "ETSY",
"friendlyId": "T4YTE8HA",
"status": "CONFIRMED",
"items": [
{
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 2,
"unitCost": {
"value": 10,
"currency": "USD"
},
"totalCost": {
"value": 10,
"currency": "USD"
},
"itemFulfillmentFee": {
"value": 10,
"currency": "USD"
},
"itemShippingCost": {
"value": 10,
"currency": "USD"
},
"itemTotalCreatorCost": {
"value": 10,
"currency": "USD"
},
"externalLineItemId": "etsy-line-item-123"
}
],
"shippingAddress": {
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main Street",
"city": "San Francisco",
"zip": "94105",
"country": "US",
"address2": "Apt 4B",
"state": "CA",
"phone": "+1-555-123-4567"
},
"costs": {
"fulfillmentFee": {
"value": 10,
"currency": "USD"
},
"manufacturingCost": {
"value": 10,
"currency": "USD"
},
"shippingCost": {
"value": 10,
"currency": "USD"
},
"totalCreatorCost": {
"value": 10,
"currency": "USD"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}This endpoint is in beta and subject to change.
OAuth scope:
order_writeAPI keys have full access to this endpoint.Authorizations
oauthbasicAuth
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Minimum string length:
1Example:
"ETSY-123456789"
Minimum string length:
1Example:
"ETSY"
Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"customer@example.com"
Show child attributes
Show child attributes
Admin-only tax treatment override. COLLECT forces tax collection; SKIP forces no tax. Omit to use the default merchant-of-record rules. Honored only for internal Fourthwall admins; any other caller that sets it is rejected.
Available options:
COLLECT, SKIP Example:
"SKIP"
Justification for the override. Required when taxOverride = SKIP.
Example:
"Customer is the merchant of record (resale)"
Response
Created
Example:
"b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d"
Example:
"ETSY-123456789"
Example:
"ETSY"
Example:
"T4YTE8HA"
Example:
"CONFIRMED"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes