Skip to content
/Discounts

Aryeo (1.0.0)

Introduction

The Aryeo API provides access to the Aryeo platform.

Overview
URL
https://www.aryeo.com
Admin
jarrodp@zillowgroup.com
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://docs.aryeo.com/_mock/api/aryeo/
Production
https://api.aryeo.com/v1/

Addresses

Operations related to addresses. Addresses provide standardized address data.

Operations

Appointments

Operations related to appointments. Appointments are bookings for services that can be rescheduled, cancelled, and confirmed.

Operations

Company Users

Operations related to company users. Companies capture media for their customers. Company users represent photographers, videographers, administrators, and other staff.

Operations

Customer Users

Operations related to customer users. Customers receive media from companies. Customer users represent real-estate agents, assistants, listing coordinators, and brokerage members.

Operations

Discounts

Operations related to discounts. Discounts support percentage or fixed-amount discounts, and coupon codes.

Operations

List coupons.

Request

List coupons.

external: true
Security
Token
Query
filter[search]string(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

Return coupons that have a name matching this field.

Example: filter[search]=00000000-0000-4000-8000-000000000000
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=promotion_codes
sortstring[ 1 .. 100 ] characters

Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to -created_at.

Example: sort=-created_at
per_pagestring[ 1 .. 5 ] characters

The number of items per page. Defaults to 25.

Example: per_page=25
pagestring[ 1 .. 5 ] characters

The requested page. Defaults to 1.

Example: page=2
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/coupons`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

CouponCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataArray of objects or null(Coupon)

A collection of objects.

metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "VIP Customer Discount",
      "is_active": true,
      "is_percent_off": true,
      "percent_off": 0.075,
      "amount_off": 2500,
      "amount_off_formatted": "$25.00",
      "promotion_codes": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "code": "SPRING_SALE",
          "times_redeemed": 10,
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "max_redemptions": 10,
          "max_redemptions_per_customer": 10,
          "first_time_only": true,
          "minimum_amount": 1000,
          "is_portal_mobile_app_only": true
        }
      ],
      "discountables": [
        {
          "object": "DISCOUNTABLE",
          "id": "00000000-0000-4000-8000-000000000000",
          "discountable": { … }
        }
      ],
      "times_redeemed": 10,
      "created_at": "2021-06-30T20:30:00Z"
    }
  ],
  "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,
        "page": 2
      }
    ]
  },
  "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"
}

Create discount.

Request

Create discount.

external: true
Security
Token
Bodyapplication/json

DiscountPostPayload

order_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the order apply this coupon to. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
coupon_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

ID of the coupon to apply. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
coupon_dataobject

Data to construct an ad hoc coupon inline to apply to this order. If you create a coupon upfront, pass the coupon_id parameter. Otherwise, this coupon_data will be used to scaffold a new ad hoc Coupon.

const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/discounts`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      order_id: '00000000-0000-4000-8000-000000000000',
      coupon_id: '00000000-0000-4000-8000-000000000000',
      coupon_data: {
        name: 'VIP Customer Discount',
        percent_off: 0.075,
        amount_off: 2500
      }
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

DiscountResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Discount)

A discount represents the application of a coupon to an order or order item. It includes the calculated amount to be discounted based on the coupon configuration.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "object": "DISCOUNT",
    "id": "00000000-0000-4000-8000-000000000000",
    "total_discount_amount": 1000,
    "coupon": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "VIP Customer Discount",
      "is_active": true,
      "is_percent_off": true,
      "percent_off": 0.075,
      "amount_off": 2500,
      "amount_off_formatted": "$25.00",
      "promotion_codes": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "code": "SPRING_SALE",
          "times_redeemed": 10,
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "max_redemptions": 10,
          "max_redemptions_per_customer": 10,
          "first_time_only": true,
          "minimum_amount": 1000,
          "is_portal_mobile_app_only": true
        }
      ],
      "discountables": [
        {
          "object": "DISCOUNTABLE",
          "id": "00000000-0000-4000-8000-000000000000",
          "discountable": { … }
        }
      ],
      "times_redeemed": 10,
      "created_at": "2021-06-30T20:30:00Z"
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Delete discount.

Request

Delete discount.

external: true
Security
Token
Path
discount_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a discount. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const discountId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/discounts/${discountId}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

if (resp.status === 204) {
  console.log('success');
} else {
  const data = await resp.text();
  console.log(data);
}

Responses

No Content

Response
No content

Delete order discount.

Request

Delete order discount.

undocumented: false
external: true
Security
Token
Path
orderstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an order. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
discountstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a discount. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const order = '00000000-0000-4000-8000-000000000000';
const discount = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders/${order}/discounts/${discount}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

OrderResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Order)

A payment request for some content or service.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "object": "ORDER",
    "id": "00000000-0000-4000-8000-000000000000",
    "identifier": "Order #2",
    "number": 100,
    "title": "Order #100",
    "status": "GHOST",
    "order_status": "OPEN",
    "is_ghost": true,
    "fulfilled_at": "2021-06-30T20:30:00Z",
    "fulfillment_status": "FULFILLED",
    "payment_status": "PAID",
    "internal_notes": "Hey there notes!",
    "currency": "USD",
    "total_amount": 2099,
    "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
    "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
    "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
    "downloads_allowed": true,
    "payments_allowed": true,
    "address": {
      "id": "00000000-0000-4000-8000-000000000000",
      "latitude": 42.35157458574123,
      "longitude": -71.05763741484657,
      "street_number": "107",
      "street_name": "South St",
      "unit_number": "Unit 2F",
      "postal_code": "02111",
      "city": "Boston",
      "city_region": "Leather District",
      "county_or_parish": "Suffolk County",
      "state_or_province": "MA",
      "state_or_province_region": "Cape Cod",
      "country": "US",
      "country_region": "Napa Valley",
      "timezone": "America/New_York",
      "unparsed_address": "107 South St, Boston MA, 02111",
      "unparsed_address_part_one": "107 South St, Unit 2F",
      "unparsed_address_part_two": "Boston, MA 02111",
      "is_map_dirty": true
    },
    "customer": {
      "object": "GROUP",
      "id": "00000000-0000-4000-8000-000000000000",
      "type": "AGENT",
      "name": "John Doe Reality",
      "email": "john.doe@gmail.com",
      "phone": "6175550173",
      "website_url": "https://www.aryeo.com",
      "logo_url": "https://picsum.photos/300",
      "office_name": "John Doe Brokerage",
      "license_number": "12345678",
      "timezone": "America/New_York",
      "currency": "USD",
      "slug": "example-photography",
      "order_page_url": "https://example-photography.aryeo.com/order",
      "feature_flags": [
        "require_photographer_confirmations"
      ],
      "order_page_background_color": "#FF0000",
      "social_profiles": {
        "facebook_profile_url": "https://www.facebook.com/johndoe",
        "instagram_profile_url": "https://www.instagram.com/johndoe",
        "twitter_profile_url": "https://twitter.com/johndoe",
        "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
        "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
      },
      "default_order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": {},
        "owner": {},
        "company": {}
      },
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "use_instant_appointment_scheduling": true,
      "allow_order_cancellation": true,
      "order_forms": [
        {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": {},
          "company": {}
        }
      ],
      "owner": {
        "object": "PERSONAL_ACCESS_TOKEN",
        "id": "00000000-0000-4000-8000-000000000000",
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "internal_notes": "Internal notes for the user.",
        "status": "active",
        "phone": "123456789",
        "avatar_url": "https://picsum.photos/300",
        "relationship": "owner",
        "sso_users": [
          { … }
        ],
        "is_super": true,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "users": [
        {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_group": {
      "object": "CUSTOMER_TEAM",
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "John Doe Customer Group",
      "description": "John Doe Customer Team is a customer team for John Doe.",
      "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
      "logo_url": "https://picsum.photos/640/480",
      "brokerage_name": "Grimes-Mante",
      "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
      "affiliate_id": "JOHN_DOE",
      "should_display_original_price": true,
      "should_disable_automated_payment_reminder_email": true,
      "should_lock_downloads_before_payment": true,
      "order_form_id": "00000000-0000-4000-8000-000000000000",
      "created_at": "2025-03-07T13:59:03.000000Z",
      "is_showingtimeplus_team": true,
      "billing_customer": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "billing_customer_pays_externally": true,
      "status": "active",
      "is_archived": true,
      "website": "https://www.aryeo.com",
      "is_default": true,
      "company": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "tags": [
        {
          "object": "APP\\TAGS\\MODELS\\TAG",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "Photography",
          "slug": "photography",
          "color": "#8BC34A",
          "font_color": "#FFFFFF",
          "type": "order"
        }
      ]
    },
    "listing": {
      "object": "LISTING",
      "id": "00000000-0000-4000-8000-000000000000",
      "address": {
        "id": "00000000-0000-4000-8000-000000000000",
        "latitude": 42.35157458574123,
        "longitude": -71.05763741484657,
        "street_number": "107",
        "street_name": "South St",
        "unit_number": "Unit 2F",
        "postal_code": "02111",
        "city": "Boston",
        "city_region": "Leather District",
        "county_or_parish": "Suffolk County",
        "state_or_province": "MA",
        "state_or_province_region": "Cape Cod",
        "country": "US",
        "country_region": "Napa Valley",
        "timezone": "America/New_York",
        "unparsed_address": "107 South St, Boston MA, 02111",
        "unparsed_address_part_one": "107 South St, Unit 2F",
        "unparsed_address_part_two": "Boston, MA 02111",
        "is_map_dirty": true
      },
      "mls_number": "1850209",
      "type": "RESIDENTIAL",
      "sub_type": "SINGLE_FAMILY_RESIDENCE",
      "status": "COMING_SOON",
      "standard_status": "ACTIVE",
      "thumbnail_url": "https://picsum.photos/640/480",
      "large_thumbnail_url": "https://picsum.photos/1280/960",
      "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
      "lot": {
        "size_acres": 0.47,
        "open_parking_spaces": 3
      },
      "building": {
        "bedrooms": 4,
        "bathrooms": 3.5,
        "square_feet": 2511,
        "year_built": 1960,
        "bedrooms_number": 4
      },
      "price": {
        "list_price": 250000,
        "list_price_formatted": "$250,000"
      },
      "list_agent": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "co_list_agent": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "customer_team_memberships": [
        {
          "object": "CUSTOMER_TEAM_MEMBERSHIP",
          "id": "00000000-0000-4000-8000-000000000000",
          "role": "admin",
          "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
          "status": "active",
          "customer_team": { … },
          "is_active": true,
          "is_archived": true,
          "is_deleted": true,
          "is_invited": true,
          "is_default": true,
          "created_at": "2025-04-01T05:59:59.999999Z",
          "customer_user": { … },
          "listing_delivery_notification_enabled": true,
          "is_showingtimeplus_workspace_membership": true,
          "is_visible": true,
          "order_index": 1
        }
      ],
      "images": [
        {
          "object": "IMAGE",
          "id": "00000000-0000-4000-8000-000000000000",
          "thumbnail_url": "https://picsum.photos/250/200",
          "large_url": "https://picsum.photos/1750/1400",
          "filename": "image.jpg",
          "original_url": "https://picsum.photos/2500/2000",
          "index": 2,
          "caption": "This is the front of the house.",
          "display_in_gallery": true
        }
      ],
      "files": [
        {
          "object": "FILE",
          "id": "0197f537-84c8-7329-b833-e28cd814a1ce",
          "uuid": "0197f537-84c8-7329-b833-e28cd814a1ce",
          "filename": "f7149b39-c3bf-47a1-b023-2f2e476ed0e5",
          "file_type": "jpg",
          "description": "Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad.",
          "display_type": "none",
          "url": "https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg"
        }
      ],
      "videos": [
        {
          "object": "VIDEO",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "The New Vimeo Player (You Know, For Videos)",
          "duration": 360,
          "display_type": "BRANDED",
          "source_type": "OPTIMIZED",
          "thumbnail_url": "https://picsum.photos/300",
          "playback_url": "https://player.vimeo.com/video/76979871",
          "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4",
          "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1"
        }
      ],
      "floor_plans": [
        {
          "object": "FLOORPLAN",
          "id": "00000000-0000-4000-8000-000000000000",
          "original_url": "https://picsum.photos/2500/2000",
          "large_url": "https://picsum.photos/1750/1400",
          "thumbnail_url": "https://picsum.photos/250/200",
          "title": "Downstairs floorplan",
          "index": 1
        }
      ],
      "interactive_content": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "My Matterport",
          "display_type": "BRANDED",
          "content_type": "MATTERPORT",
          "url": "https://my.matterport.com/show/?m=HFaxPzqNFfm",
          "thumbnail_url": "https://picsum.photos/300"
        }
      ],
      "property_website": {
        "id": "00000000-0000-4000-8000-000000000000",
        "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded",
        "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"
      },
      "marketing_materials": [
        {
          "object": "MARKETING_MATERIAL",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "New marketing material",
          "thumbnail_url": "https://picsum.photos/250/200",
          "published_at": "2021-06-30T20:30:00Z",
          "polotno_json": { … },
          "listing_download_hash": "00000000-0000-4000-8000-000000000000",
          "json_updated_at": 1624057368000,
          "exports": [ … ]
        }
      ],
      "esoft_order_lines": [
        {
          "object": "ESOFT_ORDER_LINE",
          "id": "00000000-0000-4000-8000-000000000000",
          "esoft_order_line_id": 6141841,
          "client_id": 701334,
          "reference": "123 Main St",
          "status": "complete",
          "esoft_product_id": 700012,
          "esoft_product_name": "Standard Photo Editing",
          "esoft_product_variant": "PH_VT",
          "quantity": 10,
          "comments": "Please add a watermark to the photos."
        }
      ],
      "orders": [
        {}
      ],
      "appointments": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "status": "SCHEDULED",
          "title": "Appointment title",
          "description": "Customer: John Doe\nOrder Details: Order #123",
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "rescheduled_at": "2021-06-30T20:30:00Z",
          "postponed_at": "2021-06-30T20:30:00Z",
          "previous_start_at": "2021-06-30T20:30:00Z",
          "preference_type": "TIME",
          "preferred_start_at": "2021-06-30T20:30:00Z",
          "preferred_start_at_day": "2021-06-30",
          "preferred_start_at_time_of_day": "AFTERNOON",
          "duration": 60,
          "user_has_appointments_manage_permission": true,
          "order": {},
          "users": [ … ],
          "items": [ … ],
          "can_cancel": true,
          "can_reschedule": true,
          "is_within_cancellation_lock_period": true,
          "is_within_rescheduling_lock_period": true,
          "deleted_at": "2021-06-30T20:30:00Z",
          "requires_confirmation": true,
          "late_cancellation_fee": [ … ],
          "updated_at": "2021-06-30T20:30:00Z",
          "company_team_members": [ … ],
          "appointment_attendances": [ … ]
        }
      ],
      "unconfirmed_appointments": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "status": "SCHEDULED",
          "title": "Appointment title",
          "description": "Customer: John Doe\nOrder Details: Order #123",
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "rescheduled_at": "2021-06-30T20:30:00Z",
          "postponed_at": "2021-06-30T20:30:00Z",
          "previous_start_at": "2021-06-30T20:30:00Z",
          "preference_type": "TIME",
          "preferred_start_at": "2021-06-30T20:30:00Z",
          "preferred_start_at_day": "2021-06-30",
          "preferred_start_at_time_of_day": "AFTERNOON",
          "duration": 60,
          "user_has_appointments_manage_permission": true,
          "order": {},
          "users": [ … ],
          "items": [ … ],
          "can_cancel": true,
          "can_reschedule": true,
          "is_within_cancellation_lock_period": true,
          "is_within_rescheduling_lock_period": true,
          "deleted_at": "2021-06-30T20:30:00Z",
          "requires_confirmation": true,
          "late_cancellation_fee": [ … ],
          "updated_at": "2021-06-30T20:30:00Z",
          "company_team_members": [ … ],
          "appointment_attendances": [ … ]
        }
      ],
      "downloads_enabled": true,
      "is_showcase": true,
      "is_showcasable": true,
      "has_high_resolution_images": true,
      "has_zillow_imx_tour": true,
      "delivery_status": "DELIVERED"
    },
    "order_form": {
      "object": "ORDER_FORM",
      "id": "00000000-0000-4000-8000-000000000000",
      "title": "BQ's Photography Order Form",
      "type": "ARYEO",
      "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
      "is_public": true,
      "thumbnail_url": "https://picsum.photos/300",
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "require_upfront_payment": true,
      "upfront_payment_percentage": 50,
      "use_instant_appointment_scheduling": true,
      "form_settings": {},
      "owner": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "company": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      }
    },
    "discounts": [
      {
        "object": "DISCOUNT",
        "id": "00000000-0000-4000-8000-000000000000",
        "total_discount_amount": 1000,
        "coupon": {
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "VIP Customer Discount",
          "is_active": true,
          "is_percent_off": true,
          "percent_off": 0.075,
          "amount_off": 2500,
          "amount_off_formatted": "$25.00",
          "promotion_codes": [ … ],
          "discountables": [ … ],
          "times_redeemed": 10,
          "created_at": "2021-06-30T20:30:00Z"
        }
      }
    ],
    "tags": [
      {
        "object": "APP\\TAGS\\MODELS\\TAG",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "Photography",
        "slug": "photography",
        "color": "#8BC34A",
        "font_color": "#FFFFFF",
        "type": "order"
      }
    ],
    "items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {
          "id": "00000000-0000-4000-8000-000000000000",
          "status": "SCHEDULED",
          "title": "Appointment title",
          "description": "Customer: John Doe\nOrder Details: Order #123",
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "rescheduled_at": "2021-06-30T20:30:00Z",
          "postponed_at": "2021-06-30T20:30:00Z",
          "previous_start_at": "2021-06-30T20:30:00Z",
          "preference_type": "TIME",
          "preferred_start_at": "2021-06-30T20:30:00Z",
          "preferred_start_at_day": "2021-06-30",
          "preferred_start_at_time_of_day": "AFTERNOON",
          "duration": 60,
          "user_has_appointments_manage_permission": true,
          "order": {},
          "users": [ … ],
          "items": [ … ],
          "can_cancel": true,
          "can_reschedule": true,
          "is_within_cancellation_lock_period": true,
          "is_within_rescheduling_lock_period": true,
          "deleted_at": "2021-06-30T20:30:00Z",
          "requires_confirmation": true,
          "late_cancellation_fee": [ … ],
          "updated_at": "2021-06-30T20:30:00Z",
          "company_team_members": [ … ],
          "appointment_attendances": [ … ]
        },
        "discounts": [
          { … }
        ],
        "order": {},
        "product": {
          "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": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "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
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "custom_items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {
          "id": "00000000-0000-4000-8000-000000000000",
          "status": "SCHEDULED",
          "title": "Appointment title",
          "description": "Customer: John Doe\nOrder Details: Order #123",
          "start_at": "2021-06-30T20:30:00Z",
          "end_at": "2021-06-30T20:30:00Z",
          "rescheduled_at": "2021-06-30T20:30:00Z",
          "postponed_at": "2021-06-30T20:30:00Z",
          "previous_start_at": "2021-06-30T20:30:00Z",
          "preference_type": "TIME",
          "preferred_start_at": "2021-06-30T20:30:00Z",
          "preferred_start_at_day": "2021-06-30",
          "preferred_start_at_time_of_day": "AFTERNOON",
          "duration": 60,
          "user_has_appointments_manage_permission": true,
          "order": {},
          "users": [ … ],
          "items": [ … ],
          "can_cancel": true,
          "can_reschedule": true,
          "is_within_cancellation_lock_period": true,
          "is_within_rescheduling_lock_period": true,
          "deleted_at": "2021-06-30T20:30:00Z",
          "requires_confirmation": true,
          "late_cancellation_fee": [ … ],
          "updated_at": "2021-06-30T20:30:00Z",
          "company_team_members": [ … ],
          "appointment_attendances": [ … ]
        },
        "discounts": [
          { … }
        ],
        "order": {},
        "product": {
          "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": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "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
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "appointments": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "status": "SCHEDULED",
        "title": "Appointment title",
        "description": "Customer: John Doe\nOrder Details: Order #123",
        "start_at": "2021-06-30T20:30:00Z",
        "end_at": "2021-06-30T20:30:00Z",
        "rescheduled_at": "2021-06-30T20:30:00Z",
        "postponed_at": "2021-06-30T20:30:00Z",
        "previous_start_at": "2021-06-30T20:30:00Z",
        "preference_type": "TIME",
        "preferred_start_at": "2021-06-30T20:30:00Z",
        "preferred_start_at_day": "2021-06-30",
        "preferred_start_at_time_of_day": "AFTERNOON",
        "duration": 60,
        "user_has_appointments_manage_permission": true,
        "order": {},
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "can_cancel": true,
        "can_reschedule": true,
        "is_within_cancellation_lock_period": true,
        "is_within_rescheduling_lock_period": true,
        "deleted_at": "2021-06-30T20:30:00Z",
        "requires_confirmation": true,
        "late_cancellation_fee": [
          {}
        ],
        "updated_at": "2021-06-30T20:30:00Z",
        "company_team_members": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "unconfirmed_appointments": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "status": "SCHEDULED",
        "title": "Appointment title",
        "description": "Customer: John Doe\nOrder Details: Order #123",
        "start_at": "2021-06-30T20:30:00Z",
        "end_at": "2021-06-30T20:30:00Z",
        "rescheduled_at": "2021-06-30T20:30:00Z",
        "postponed_at": "2021-06-30T20:30:00Z",
        "previous_start_at": "2021-06-30T20:30:00Z",
        "preference_type": "TIME",
        "preferred_start_at": "2021-06-30T20:30:00Z",
        "preferred_start_at_day": "2021-06-30",
        "preferred_start_at_time_of_day": "AFTERNOON",
        "duration": 60,
        "user_has_appointments_manage_permission": true,
        "order": {},
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "can_cancel": true,
        "can_reschedule": true,
        "is_within_cancellation_lock_period": true,
        "is_within_rescheduling_lock_period": true,
        "deleted_at": "2021-06-30T20:30:00Z",
        "requires_confirmation": true,
        "late_cancellation_fee": [
          {}
        ],
        "updated_at": "2021-06-30T20:30:00Z",
        "company_team_members": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "created_at": "2021-06-30T20:30:00Z",
    "updated_at": "2021-06-30T20:30:00Z",
    "custom_fields": [
      {}
    ],
    "taxes": [
      {
        "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
        }
      }
    ],
    "booking_limits": {
      "object": "COMPANY",
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "use_instant_appointment_scheduling": true,
      "is_twilight_visible": true
    },
    "filter_by_square_feet": true,
    "filter_by_list_price": true,
    "scheduling_assignment_strategy": "RECOMMENDED",
    "balance_amount": 2099,
    "total_tax_amount": 2099,
    "total_discount_amount": 2099,
    "payments": [
      {
        "object": "ORDER_PAYMENT",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "MANUAL",
        "collection_source": "CASH",
        "completed_at": "2021-06-30T20:30:00Z",
        "applicable_amount": 502,
        "tip_amount": 100,
        "total_amount": 502,
        "collected_amount": 502,
        "order": {}
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Redeem promotion code.

Request

Redeem promotion code.

undocumented: true
external: true
Path
discountedTypestring[ 1 .. 255 ] charactersrequired

The type of discountable.

Enum"product""fee"
Example: product
discountedstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a discountable. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const discountedType = 'product';
const discounted = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/promotion-codes/redeem/${discountedType}/${discounted}`,
  {method: 'POST'}
);

const data = await resp.text();
console.log(data);

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Refund order payment.

Request

Refund order payment.

undocumented: true
external: true
Security
Token
Path
orderPaymentstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an order payment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const orderPayment = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/refunds/${orderPayment}`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Listings

Operations related to listings. Listings are the core entity that connects properties with media services.

Operations

Notes

Operations related to notes. Notes are contextual comments across various entities including orders, listings, customers, and appointments.

Operations

Order Forms

Operations related to order forms. Order forms are the customer-facing booking interfaces for service requests, product selection, and appointment scheduling.

Operations

Order Items

Operations related to order items. Order items are the individual line items within orders.

Operations

Orders

Operations related to orders. Orders are the service orders from customers.

Operations

Payroll

Operations related to payroll.

Operations

Products

Operations related to products. Products consist of the categories and offerings for services and products.

Operations

Scheduling

Operations related to scheduling. Scheduling operations provide information about service provider availability.

Operations

Tags

Operations related to tags. Tags are used to organize and categorize content using a flexible tagging system.

Operations

Tasks

Operations related to tasks. Tasks are used to track work items, assignments, and completion status.

Operations

Videos

Operations related to videos.

Operations