Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Orders

Get order by friendly id

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns order by friendly id

get/open-api/v1.0/order/by-friendly-id/{friendlyId}

Path parameters

friendlyIdstring required

Response

OK

idstring required
shopIdstring required
friendlyIdstring required
checkoutIdstring required
promotionIdstring
status'CONFIRMED' | 'PARTIALLY_IN_PRODUCTION' | 'IN_PRODUCTION' | 'PARTIALLY_SHIPPED' | 'SHIPPED' | 'PARTIALLY_DELIVERED' | 'DELIVERED' | 'CANCELLED' | 'COMPLETED' required
emailstring required
emailMarketingOptInboolean required
usernamestring
messagestring required
metadataobject

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

createdAtstring date-time required
updatedAtstring date-time required

Example response

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