Aryeo (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Customer Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Discounts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Listings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Notes
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Order Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Order Items
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Orders
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

List orders.

Request

Lists all orders of a group.

external: true

Security

Token

Query

includestring[ 0 .. 255 ] characters

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

Example: include=items,listing,customer,appointments,appointments.users,unconfirmed_appointments,order_form,discounts,discounts.coupon

filter[search]string[ 0 .. 255 ] characters

Return orders with addresses or customers that match on this string.

Example: filter[search]=123 Imperial

filter[payment_status]string[ 0 .. 255 ] characters

Return orders with the specified payment status. Available payment statuses are PAID, PARTIALLY_PAID, and UNPAID.

Example: filter[payment_status]=PAID

filter[fulfillment_status]string[ 0 .. 255 ] characters

Return orders with the specified fulfillment status. Available fulfillment statuses are FULFILLED, PARTIALLY_FULFILLED, and UNFULFILLED.

Example: filter[fulfillment_status]=123 Imperial

filter[appointment_start_at_gte]string(date-time)= 20 characters

Return orders with an appointment starting after this date.

Example: filter[appointment_start_at_gte]=2021-01-01T13:00:00Z

filter[appointment_start_at_lte]string(date-time)= 20 characters

Return orders with an appointment starting before this date.

Example: filter[appointment_start_at_lte]=2021-01-01T13:00:00Z

filter[creator_group_id]string[ 1 .. 100 ] characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

Creator group ID used to list orders owned by a specific creator.

Example: filter[creator_group_id]=00000000-0000-4000-8000-000000000000

filter[tag_ids][]Array of strings(uuid)

Set to include orders with tags that match any of the tags provided.

Example: filter[tag_ids][]=00000000-0000-4000-8000-000000000000

filter[user_ids][]Array of strings(uuid)

Set to include orders that have appointments with the given users.

Example: filter[user_ids][]=00000000-0000-4000-8000-000000000000

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=appointment_start

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/orders`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

OrderCollection

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataArray of objects or null(Order)

A collection of objects.

metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Create order.

Request

Create order.

external: true

Security

Token

Bodyapplication/json

OrderPostPayload

fulfillment_statusstring or null[ 0 .. 255 ] characters

The fulfillment status of the order. Defaults to 'UNFULFILLED'.

Enum"FULFILLED""UNFULFILLED"

Example: "FULFILLED"

internal_notesstring or null[ 0 .. 2550 ] characters

Internal notes that will be attached to the order. Viewable only by the team.

Example: "Private note about the order!"

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

ID of the address to associate with the order. UUID Version 4.

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

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

ID of the customer to associate with the order. UUID Version 4.

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

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

ID of the company to associate with the order. UUID Version 4.

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

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

ID of the customer team membership to associate with the order. UUID Version 4.

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

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

ID of the listing to associate with the order. UUID Version 4.

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

notifyboolean or null

Indicates if the customer and creator notifications should be sent when creating the order. Requires an address and customer to be set in order for the notifications to be sent.

Example: true

lock_download_for_paymentboolean or null

Indicates if the downloads for the attached listing should be locked while there is an outstanding balance on the order.

Example: true

allow_payments_before_fulfillmentboolean or null

Indicates if the order will allow payments from the customer before the order is marked as fulfilled.

Example: true

product_itemsArray of objects

An array of product items.

const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      fulfillment_status: 'FULFILLED',
      internal_notes: 'Private note about the order!',
      address_id: '00000000-0000-4000-8000-000000000000',
      customer_id: '00000000-0000-4000-8000-000000000000',
      company_id: '00000000-0000-4000-8000-000000000000',
      customer_team_membership_id: '00000000-0000-4000-8000-000000000000',
      listing_id: '00000000-0000-4000-8000-000000000000',
      notify: true,
      lock_download_for_payment: true,
      allow_payments_before_fulfillment: true,
      product_items: [
        {
          variant_id: '00000000-0000-4000-8000-000000000000',
          quantity: 3
        }
      ]
    })
  }
);

const data = await resp.json();
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"
}

Get order.

Request

Get order.

external: true

Security

Token

Path

order_idstring(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

Query

includestring[ 0 .. 255 ] characters

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

Example: include=items,listing,customer,appointments,appointments.users,unconfirmed_appointments,order_form,discounts,discounts.coupon

const orderId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders/${orderId}`,
  {
    method: 'GET',
    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"
}

Create a manual order payment.

Request

Create a manual order payment.

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

Bodyapplication/jsonrequired

amountinteger>= 1required

The amount in cents

Example: 500

tip_amountinteger>= 0

The tip amount in cents

Example: 100

collection_sourcestring[ 5 .. 10 ] charactersrequired

The source of the payment

Enum"PAYPAL""VENMO""STRIPE""SQUARE""QUICKBOOKS""CONCIERGE""CASH""CHECK""OTHER"

Example: "CASH"

datestring(date)= 10 charactersrequired

The date for the payment in UTC (YYYY-MM-DD)

Example: "2025-01-01"

notesstring[ 0 .. 10000 ] characters

Optional description of the payment

Example: "Description of payment"

const order = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders/${order}/payments`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      amount: 500,
      tip_amount: 100,
      collection_source: 'CASH',
      date: '2025-01-01',
      notes: 'Description of payment'
    })
  }
);

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

Responses

201

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(Payment)required

A payment is a single unit of payment that can be applied to an order.

data.objectstring= 13 charactersrequired

A canonical value representing a resource.

Value"ORDER_PAYMENT"

Example: "ORDER_PAYMENT"

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

ID of the entity. UUID Version 4.

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

data.typestring[ 0 .. 255 ] charactersrequired

Payment type

Enum"MANUAL""CREDIT""CHECKOUT"

Example: "MANUAL"

data.collection_sourcestring[ 0 .. 255 ] charactersrequired

Source of payment collection

Enum"PAYPAL""VENMO""STRIPE""SQUARE""QUICKBOOKS""CONCIERGE""CASH""CHECK""OTHER"

Example: "CASH"

data.completed_atstring or null(date-time)= 20 charactersrequired

Timestamp when the payment was completed

Example: "2021-06-30T20:30:00Z"

data.applicable_amountintegerrequired

The applicable amount for the payment

Example: 502

data.tip_amountintegerrequired

The tip amount included in the payment

Example: 100

data.total_amountintegerrequired

The total payment amount

Example: 502

data.collected_amountintegerrequired

The amount actually collected

Example: 502

data.orderobject(Order)

A payment request for some content or service.

timestampstring or null(date-time)

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "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": {
      "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": [
          { … }
        ],
        "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_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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": [
          { … }
        ]
      },
      "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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": [
          { … }
        ],
        "images": [
          { … }
        ],
        "files": [
          { … }
        ],
        "videos": [
          { … }
        ],
        "floor_plans": [
          { … }
        ],
        "interactive_content": [
          { … }
        ],
        "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": [
          { … }
        ],
        "esoft_order_lines": [
          { … }
        ],
        "orders": [
          {}
        ],
        "appointments": [
          { … }
        ],
        "unconfirmed_appointments": [
          { … }
        ],
        "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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "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": { … },
          "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": { … }
        }
      ],
      "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": { … },
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "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": { … },
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "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": { … }
        }
      ],
      "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": [
        {}
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Update order billing address.

Request

Update order billing address.

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

Bodyapplication/json

citystring or null[ 0 .. 255 ] characters

The city of the order's billing address.

Example: "Edison"

city_regionstring or null[ 0 .. 255 ] characters

The region of the order's billing address.

Example: ""

county_or_parishstring or null[ 0 .. 255 ] characters

The county or parish of the order's billing address.

Example: ""

latitudenumber or null[ -180 .. 180 ]

The latitude of the order's billing address.

Example: 40.52288659999999

longitudenumber or null[ -180 .. 180 ]

The longitude of the order's billing address.

Example: -74.35929720000001

postal_codestring or null[ 0 .. 255 ] characters

The postal code of the order's billing address.

Example: "08817"

state_or_provincestring or null[ 0 .. 255 ] characters

The state or province of the order's billing address.

Example: "NJ"

state_or_province_regionstring or null[ 0 .. 255 ] characters

The region of the state or province of the order's billing address.

Example: ""

street_namestring or null[ 0 .. 255 ] characters

The street name of the order's billing address.

Example: "Main St"

street_numberstring or null[ 0 .. 255 ] characters

The street number of the order's billing address.

Example: "123"

unit_numberstring or null[ 0 .. 255 ] characters

The unit number of the order's billing address.

Example: ""

const order = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders/${order}/billing-address`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      city: 'Edison',
      city_region: '',
      county_or_parish: '',
      latitude: 40.52288659999999,
      longitude: -74.35929720000001,
      postal_code: '08817',
      state_or_province: 'NJ',
      state_or_province_region: '',
      street_name: 'Main St',
      street_number: '123',
      unit_number: ''
    })
  }
);

const data = await resp.json();
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"
}

Get payment information an order.

Request

Get payment information an order.

undocumented: false

external: true

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

const order = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/orders/${order}/payment-info`,
  {method: 'GET'}
);

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

Responses

PaymentInfoResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(PaymentInfo)required

Payment information for an order.

data.objectstring= 12 charactersrequired

A canonical value representing a resource.

Value"PAYMENT_INFO"

Example: "PAYMENT_INFO"

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

ID of the payment info. UUID Version 4.

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

data.is_authenticatedbooleanrequired

Whether the payment is authenticated.

Example: true

data.amountintegerrequired

The amount of the payment.

Example: 1000

data.upfront_percentagenumberrequired

The upfront percentage of the payment.

Example: 0.5

data.currencystring= 3 charactersrequired

The currency of the payment.

Example: "usd"

data.is_tipping_enabledbooleanrequired

Whether tipping is enabled for the payment.

Example: true

data.show_tipping_ui_expandedbooleanrequired

Whether the tipping UI is expanded for the payment.

Example: true

data.payment_gateway_is_availablebooleanrequired

Whether the payment gateway is available for the payment.

Example: true

data.payment_methodsArray of objects(PaymentMethod)required

The payment methods for the payment.

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

The ID of the payment method.

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

data.payment_methods[].brandstring[ 1 .. 255 ] charactersrequired

The brand of the payment method.

Example: "visa"

data.payment_methods[].last_4string= 4 charactersrequired

The last 4 digits of the payment method.

Example: "1234"

data.payment_methods[].exp_monthinteger[ 1 .. 12 ]required

The month of the payment method.

Example: 1

data.payment_methods[].exp_yearinteger[ 1000 .. 9999 ]required

The year of the payment method.

Example: 2025

data.payment_methods[].is_expiredbooleanrequired

Whether the payment method is expired.

Example: true

data.payment_methods[].stripe_external_idstring[ 1 .. 255 ] charactersrequired

The external ID of the payment method.

Example: "pm_1234567890"

data.payment_methods[].square_external_idstring[ 1 .. 255 ] charactersrequired

The external ID of the payment method.

Example: "sq_1234567890"

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

The ID of the default payment method for the payment.

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

data.default_payment_gatewayobject(PaymentGateway)required

A payment gateway

data.default_payment_gateway.objectstring= 11 charactersrequired

A canonical value representing a resource.

Value"INTEGRATION"

Example: "INTEGRATION"

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

The ID of the payment gateway.

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

data.default_payment_gateway.namestring[ 1 .. 255 ] charactersrequired

The name of the payment gateway.

Example: "Stripe"

data.default_payment_gateway.typestring[ 1 .. 255 ] charactersrequired

The type of the payment gateway.

Example: "PAYMENT_GATEWAY"

data.default_payment_gateway.providerstring[ 1 .. 255 ] charactersrequired

The provider of the payment gateway.

Example: "STRIPE_CONNECT"

data.default_payment_gateway.metadataArray of objects or nullrequired

The custom field data of the payment gateway.

object

A key-value pair of custom field data for the payment gateway.

data.can_save_cardbooleanrequired

Whether the customer can save a card for the payment.

Example: true

data.configobject(PaymentInfoConfig)required

A payment info config

data.config.vgs_vault_idstring or null[ 1 .. 255 ] charactersrequired

The ID of the VGS vault.

Example: "something"

data.config.vgs_environmentstring or null[ 1 .. 255 ] charactersrequired

The environment of the VGS vault.

Example: "sandbox"

data.config.square_client_idstring or null[ 1 .. 255 ] charactersrequired

The ID of the Square client.

Example: "sandbox-something"

data.requires_billing_address_during_order_form_submissionbooleanrequired

Whether the billing address is required during the order form submission.

Example: true

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": "PAYMENT_INFO",
    "id": "00000000-0000-4000-8000-000000000000",
    "is_authenticated": true,
    "amount": 1000,
    "upfront_percentage": 0.5,
    "currency": "usd",
    "is_tipping_enabled": true,
    "show_tipping_ui_expanded": true,
    "payment_gateway_is_available": true,
    "payment_methods": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "brand": "visa",
        "last_4": "1234",
        "exp_month": 1,
        "exp_year": 2025,
        "is_expired": true,
        "stripe_external_id": "pm_1234567890",
        "square_external_id": "sq_1234567890"
      }
    ],
    "default_payment_method_id": "00000000-0000-4000-8000-000000000000",
    "default_payment_gateway": {
      "object": "INTEGRATION",
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Stripe",
      "type": "PAYMENT_GATEWAY",
      "provider": "STRIPE_CONNECT",
      "metadata": [
        {}
      ]
    },
    "can_save_card": true,
    "config": {
      "vgs_vault_id": "something",
      "vgs_environment": "sandbox",
      "square_client_id": "sandbox-something"
    },
    "requires_billing_address_during_order_form_submission": true
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Payroll
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to payroll.

Operations

Products
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Scheduling
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Tags
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

Videos
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to videos.

Operations

Aryeo (1.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Introduction

AddressesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

AppointmentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Company UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Customer UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

DiscountsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ListingsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

NotesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Order FormsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Order ItemsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

OrdersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

List orders.

Request

Responses

Was this helpful?

Create order.

RequestExpand all

Responses

Was this helpful?

Get order.

Request

Responses

Was this helpful?

Create a manual order payment.

Request

Responses

Was this helpful?

Update order billing address.

Request

Responses

Was this helpful?

Get payment information an order.

Request

Responses

Was this helpful?

PayrollCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ProductsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SchedulingCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TagsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TasksCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

VideosCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Aryeo (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Addresses
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Appointments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Company Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Customer Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Discounts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Listings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Notes
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Order Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Order Items
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Orders
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Payroll
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Products
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Scheduling
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tags
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Videos
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude