Get Order by Friendly ID

Get order by friendly id

curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}', 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/order/by-friendly-id/{friendlyId}",
  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.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}")

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

{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "friendlyId": "D3XZFWPP",
  "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  "status": "CONFIRMED",
  "email": "supporter@fourthwall.com",
  "emailMarketingOptIn": true,
  "message": "Sample message",
  "amounts": {
    "subtotal": {
      "value": 10,
      "currency": "USD"
    },
    "shipping": {
      "value": 10,
      "currency": "USD"
    },
    "tax": {
      "value": 10,
      "currency": "USD"
    },
    "donation": {
      "value": 10,
      "currency": "USD"
    },
    "discount": {
      "value": 10,
      "currency": "USD"
    },
    "giftCards": [
      {
        "code": "<string>",
        "amountUsed": {
          "value": 10,
          "currency": "USD"
        }
      }
    ],
    "total": {
      "value": 10,
      "currency": "USD"
    }
  },
  "offers": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "name": "My t-shirt",
      "slug": "my-t-shirt",
      "description": "My t-shirt description",
      "variant": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "name": "My t-shirt - Black, L",
        "sku": "WDEK-DRE200L",
        "unitPrice": {
          "value": 10,
          "currency": "USD"
        },
        "attributes": {
          "description": "Black, L",
          "color": {
            "name": "Black",
            "swatch": "#000000"
          },
          "size": {
            "name": "L"
          }
        },
        "quantity": 5,
        "price": {
          "value": 10,
          "currency": "USD"
        },
        "weight": {
          "value": 1,
          "unit": "kg"
        },
        "dimensions": {
          "length": 1,
          "width": 2,
          "height": 3,
          "unit": "cm"
        },
        "unitCost": {
          "value": 10,
          "currency": "USD"
        },
        "compareAtPrice": {
          "value": 10,
          "currency": "USD"
        },
        "cost": {
          "value": 10,
          "currency": "USD"
        }
      },
      "primaryImage": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "url": "https://fourthwall.com/image.png",
        "width": 800,
        "height": 600,
        "transformedUrl": "https://fourthwall.com/image.png"
      }
    }
  ],
  "source": {
    "type": "GIVEAWAY_LINKS",
    "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
  },
  "createdAt": "2020-08-13T09:05:36.939Z",
  "updatedAt": "2020-08-13T09:05:36.939Z",
  "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
  "username": "Johnny123",
  "billing": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "address2": "<string>",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "shipping": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "address2": "<string>",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "trackingParams": {
    "fbc": "<string>",
    "fbp": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>"
  },
  "metadata": {}
}

GET

open-api

v1.0

order

by-friendly-id

{friendlyId}

Get order by friendly id

curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}', 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/order/by-friendly-id/{friendlyId}",
  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.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/{friendlyId}")

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

{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "friendlyId": "D3XZFWPP",
  "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  "status": "CONFIRMED",
  "email": "supporter@fourthwall.com",
  "emailMarketingOptIn": true,
  "message": "Sample message",
  "amounts": {
    "subtotal": {
      "value": 10,
      "currency": "USD"
    },
    "shipping": {
      "value": 10,
      "currency": "USD"
    },
    "tax": {
      "value": 10,
      "currency": "USD"
    },
    "donation": {
      "value": 10,
      "currency": "USD"
    },
    "discount": {
      "value": 10,
      "currency": "USD"
    },
    "giftCards": [
      {
        "code": "<string>",
        "amountUsed": {
          "value": 10,
          "currency": "USD"
        }
      }
    ],
    "total": {
      "value": 10,
      "currency": "USD"
    }
  },
  "offers": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "name": "My t-shirt",
      "slug": "my-t-shirt",
      "description": "My t-shirt description",
      "variant": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "name": "My t-shirt - Black, L",
        "sku": "WDEK-DRE200L",
        "unitPrice": {
          "value": 10,
          "currency": "USD"
        },
        "attributes": {
          "description": "Black, L",
          "color": {
            "name": "Black",
            "swatch": "#000000"
          },
          "size": {
            "name": "L"
          }
        },
        "quantity": 5,
        "price": {
          "value": 10,
          "currency": "USD"
        },
        "weight": {
          "value": 1,
          "unit": "kg"
        },
        "dimensions": {
          "length": 1,
          "width": 2,
          "height": 3,
          "unit": "cm"
        },
        "unitCost": {
          "value": 10,
          "currency": "USD"
        },
        "compareAtPrice": {
          "value": 10,
          "currency": "USD"
        },
        "cost": {
          "value": 10,
          "currency": "USD"
        }
      },
      "primaryImage": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "url": "https://fourthwall.com/image.png",
        "width": 800,
        "height": 600,
        "transformedUrl": "https://fourthwall.com/image.png"
      }
    }
  ],
  "source": {
    "type": "GIVEAWAY_LINKS",
    "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
  },
  "createdAt": "2020-08-13T09:05:36.939Z",
  "updatedAt": "2020-08-13T09:05:36.939Z",
  "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
  "username": "Johnny123",
  "billing": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "address2": "<string>",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "shipping": {
    "address": {
      "name": "Joe Doe",
      "address1": "Main Street 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "address2": "<string>",
      "zip": "12345",
      "phone": "123456789"
    }
  },
  "trackingParams": {
    "fbc": "<string>",
    "fbp": "<string>",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>"
  },
  "metadata": {}
}

OAuth scope: order_readAPI keys have full access to this endpoint.

Authorizations

Authorization

string

header

required

OAuth 2.0 access token, sent as Authorization: Bearer <token>. See https://docs.fourthwall.com/guides/oauth. The scopes an operation requires are listed in its x-fourthwall-scopes.

Path Parameters

friendlyId

string

required

Response

string

required

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

shopId

string

required

Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

friendlyId

string

required

Example:

"D3XZFWPP"

checkoutId

string

required

Example:

"ch_BV44UYrXQA2T_Xcf1288tw"

status

enum<string>

required

Available options:

CONFIRMED,

PARTIALLY_IN_PRODUCTION,

IN_PRODUCTION,

PARTIALLY_SHIPPED,

SHIPPED,

PARTIALLY_DELIVERED,

DELIVERED,

CANCELLED,

COMPLETED

string

required

Example:

"supporter@fourthwall.com"

emailMarketingOptIn

boolean

required

message

string

required

Example:

"Sample message"

amounts

Order Amounts · object

required

Show child attributes

offers

Offer Order · object[]

required

Show child attributes

source

Giveaway Links · object

required

Show child attributes

createdAt

string<date-time>

required

Example:

"2020-08-13T09:05:36.939Z"

updatedAt

string<date-time>

required

Example:

"2020-08-13T09:05:36.939Z"

promotionId

string

Example:

"prm_EdJvIXu3SEiXe_QkPavHSA"

username

string

Example:

"Johnny123"

billing

Billing · object

Show child attributes

shipping

Shipping · object

Show child attributes

trackingParams

Tracking Params · object

Show child attributes

metadata

object

Custom metadata passed during cart creation. Null for orders without metadata.

Show child attributes

Shop

Products

Product Templates

Customization

Media library

Orders

Fulfillment

Webhooks

Promotions

Memberships

Donations

Mailing Lists

Streaming

Gifting

Giveaway Links

Collections

Thank Yous

Platform Token

Webhook Events

Authorizations

Path Parameters

Response