Skip to main content
GET
/
open-api
/
v1.0
/
order
Get all orders
curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/order \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "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"
        },
        "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": "<string>",
        "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": {}
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123,
  "totalPages": 123
}
OAuth scope: order_readAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

page
integer<int32>
default:0
size
integer<int32>
default:20
email
string
createdAt[gt]
string<date-time>
createdAt[lt]
string<date-time>
updatedAt[gt]
string<date-time>
updatedAt[lt]
string<date-time>
status
enum<string>[]
Available options:
CONFIRMED,
PARTIALLY_IN_PRODUCTION,
IN_PRODUCTION,
PARTIALLY_SHIPPED,
SHIPPED,
PARTIALLY_DELIVERED,
DELIVERED,
CANCELLED,
COMPLETED

Response

OK

results
Order · object[]
required
total
integer<int32>
page
integer<int32>
size
integer<int32>
totalPages
integer<int32>