Skip to main content
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>'
{
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"friendlyId": "D3XZFWPP",
"checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
"status": "CONFIRMED",
"email": "[email protected]",
"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>"
}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

friendlyId
string
required

Response

OK

id
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
email
string
required
emailMarketingOptIn
boolean
required
message
string
required
Example:

"Sample message"

amounts
Order Amounts · object
required
offers
Offer Order · object[]
required
source
Giveaway Links · object
required
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
shipping
Shipping · object
trackingParams
Tracking Params · object