The Aryeo API provides access to the Aryeo platform.
https://docs.aryeo.com/_mock/api/aryeo/
https://api.aryeo.com/v1/
Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to title.
The number of items per page. Defaults to 25.
Return products that have fields matching this term.
Include inactive products (in addition to active products) when returning products.
Return products in the given categories.
https://docs.aryeo.com/_mock/api/aryeo/products
https://api.aryeo.com/v1/products
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/products`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": [ { "object": "PRODUCT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "description": "Capture photos of a house for sale.", "active": true, "type": "MAIN", "is_twilight": true, "image_url": "https://picsum.photos/400/200", "is_serviceable": true, "requires_separate_booking": true, "always_display_addons": true, "variant_filter_type": "ALL", "avalara_tax_code": "12345", "limit_quantity_amount": 10, "limit_quantity": true, "is_filterable": true, "is_esoft_adjustment": true, "variants": [ { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 } ], "categories": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ], "tags": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ] } ], "meta": { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "from": 1, "to": 15, "path": "https://api.aryeo.com/v1/{path}", "links": [ { "url": "https://admin.aryeo.test/api/v1/companies?page=2", "label": "2", "active": true } ] }, "links": { "first": "https://api.aryeo.com/v1/{path}?page=1", "last": "https://api.aryeo.com/v1/{path}?page=10", "prev": "https://api.aryeo.com/v1/{path}?page=2", "next": "https://api.aryeo.com/v1/{path}?page=3" }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/product-categories
https://api.aryeo.com/v1/product-categories
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/product-categories`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ], "meta": { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "from": 1, "to": 15, "path": "https://api.aryeo.com/v1/{path}", "links": [ { "url": "https://admin.aryeo.test/api/v1/companies?page=2", "label": "2", "active": true } ] }, "links": { "first": "https://api.aryeo.com/v1/{path}?page=1", "last": "https://api.aryeo.com/v1/{path}?page=10", "prev": "https://api.aryeo.com/v1/{path}?page=2", "next": "https://api.aryeo.com/v1/{path}?page=3" }, "timestamp": "2021-06-30T20:30:00Z" }
TaxPostPayload
ID of the order apply this tax to. UUID Version 4.
https://docs.aryeo.com/_mock/api/aryeo/taxes
https://api.aryeo.com/v1/taxes
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/taxes`,
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
},
body: JSON.stringify({
order_id: '00000000-0000-4000-8000-000000000000',
tax_rate_data: {
name: 'New York State Tax',
description: 'Tax rate applied for any property that falls within the bounds New York State.',
applied_rate: 0.075
}
})
}
);
const data = await resp.json();
console.log(data);{ "status": "success", "data": { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { "object": "TAX_RATE", "id": "00000000-0000-4000-8000-000000000000", "name": "New York State Tax", "description": "Tax rate applied for any property that falls within the bounds New York State.", "applied_rate": 0.075, "rate": "0.075000", "is_active": true, "is_inclusive": true } }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/taxes/{tax_id}
https://api.aryeo.com/v1/taxes/{tax_id}
const taxId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/taxes/${taxId}`,
{
method: 'DELETE',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
if (resp.status === 204) {
console.log('success');
} else {
const data = await resp.text();
console.log(data);
}https://docs.aryeo.com/_mock/api/aryeo/territories
https://api.aryeo.com/v1/territories
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/territories`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": [ { "object": "TERRITORY", "id": "00000000-0000-4000-8000-000000000000", "name": "New York City" } ], "meta": { "total": 50, "per_page": 15, "current_page": 1, "last_page": 4, "from": 1, "to": 15, "path": "https://api.aryeo.com/v1/{path}", "links": [ { "url": "https://admin.aryeo.test/api/v1/companies?page=2", "label": "2", "active": true } ] }, "links": { "first": "https://api.aryeo.com/v1/{path}?page=1", "last": "https://api.aryeo.com/v1/{path}?page=10", "prev": "https://api.aryeo.com/v1/{path}?page=2", "next": "https://api.aryeo.com/v1/{path}?page=3" }, "timestamp": "2021-06-30T20:30:00Z" }