Orders

API Reference

Orders

The Aryeo API provides access to the Aryeo platform.

Overview

URL

https://www.aryeo.com

Admin

jarrodp@zillowgroup.com

License

Apache 2.0

Servers

Mock server

https://docs.aryeo.com/_mock/api/aryeo/

Production

https://api.aryeo.com/v1/

Addresses

Operations related to addresses.

Operations

Appointments

Operations related to appointments.

Operations

Discounts

Operations related to discounts.

Operations

Listings

Operations related to listings.

Operations

Notes

Operations related to notes.

Operations

Order Forms

Operations related to order forms.

Operations

Order Items

Operations related to order items.

Operations

Orders

Operations related to orders.

Operations

Check interactive contents URL.

Request

Check interactive contents URL.

undocumented: true

external: true

const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/interactive-contents/url-check`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

201

Bodyapplication/json

object

Response

application/json

{}

List orders.

Request

Lists all orders of a group.

external: true

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

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
      },
      "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
        }
      ],
      "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
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_group": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "John Doe Customer Group",
      "affiliate_id": "JOHN_DOE",
      "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
        },
        "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_visible": true,
        "order_index": 1
      }
    },
    "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": "COMING_SOON",
      "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
        },
        "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_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
        },
        "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_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
        }
      ],
      "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
        }
      ],
      "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": [ … ]
        }
      ],
      "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
        },
        "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_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
        },
        "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_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"
      }
    ],
    "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

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
      },
      "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
        }
      ],
      "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
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_group": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "John Doe Customer Group",
      "affiliate_id": "JOHN_DOE",
      "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
        },
        "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_visible": true,
        "order_index": 1
      }
    },
    "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": "COMING_SOON",
      "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
        },
        "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_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
        },
        "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_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
        }
      ],
      "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
        }
      ],
      "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": [ … ]
        }
      ],
      "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
        },
        "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_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
        },
        "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_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"
      }
    ],
    "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

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
        },
        "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_visible": true,
        "order_index": 1
      },
      "customer_group": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "affiliate_id": "JOHN_DOE",
        "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_visible": true,
          "order_index": 1
        }
      },
      "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": "COMING_SOON",
        "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_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_visible": true,
          "order_index": 1
        },
        "customer_team_memberships": [
          { … }
        ],
        "images": [
          { … }
        ],
        "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": [
          { … }
        ],
        "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_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_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"
        }
      ],
      "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: true

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

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

Responses

200

Bodyapplication/json

object

Response

application/json

{}

Get payment information an order.

Request

Get payment information an order.

undocumented: true

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

200

Bodyapplication/json

object

Response

application/json

{}

Payroll

Operations related to payroll.

Operations

Products

Operations related to products.

Operations

Scheduling

Operations related to scheduling.

Operations

Tasks

Operations related to tasks.

Operations

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations

Addresses

Appointments

Discounts

Listings

Notes

Order Forms

Order Items

Orders

Check interactive contents URL.

Request

Responses

Was this helpful?

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?

Payroll

Products

Scheduling

Tags

Tasks

Users

Videos

Request