# Create a manual order payment.

Create a manual order payment.

Endpoint: POST /orders/{order}/payments
Version: 1.0.0
Security: Token

## Path parameters:

  - `order` (string, required)
    The ID of an order. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

## Request fields (application/json):

  - `amount` (integer, required)
    The amount in cents
    Example: 500

  - `tip_amount` (integer)
    The tip amount in cents
    Example: 100

  - `collection_source` (string, required)
    The source of the payment
    Enum: "PAYPAL", "VENMO", "STRIPE", "SQUARE", "QUICKBOOKS", "CONCIERGE", "CASH", "CHECK", "OTHER"

  - `date` (string, required)
    The date for the payment in UTC (YYYY-MM-DD)
    Example: "2025-01-01"

  - `notes` (string)
    Optional description of the payment
    Example: "Description of payment"

## Response 201 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "success"

  - `data` (object, required)
    A payment is a single unit of payment that can be applied to an order.

  - `data.object` (string, required)
    A canonical value representing a resource.
    Enum: "ORDER_PAYMENT"

  - `data.id` (string, required)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.type` (string, required)
    Payment type
    Enum: "MANUAL", "CREDIT", "CHECKOUT"

  - `data.collection_source` (string, required)
    Source of payment collection
    Enum: "PAYPAL", "VENMO", "STRIPE", "SQUARE", "QUICKBOOKS", "CONCIERGE", "CASH", "CHECK", "OTHER"

  - `data.completed_at` (string,null, required)
    Timestamp when the payment was completed
    Example: "2021-06-30T20:30:00Z"

  - `data.applicable_amount` (integer, required)
    The applicable amount for the payment
    Example: 502

  - `data.tip_amount` (integer, required)
    The tip amount included in the payment
    Example: 100

  - `data.total_amount` (integer, required)
    The total payment amount
    Example: 502

  - `data.collected_amount` (integer, required)
    The amount actually collected
    Example: 502

  - `data.order` (object)
    A payment request for some content or service.

  - `data.order.identifier` (string,null)
    A vanity id used for internal tracking of orders for a given vendor.
    Example: "Order #2"

  - `data.order.number` (integer,null)
    A vanity id used for internal tracking of orders for a given vendor.
    Example: 100

  - `data.order.title` (string, required)
    The title of the order, generated by combining the order's number property with the prefix 'Order #'.
    Example: "Order #100"

  - `data.order.status` (string)
    The status of the order.
    Enum: "CONFIRMED", "GHOST"

  - `data.order.order_status` (string)
    The status of the order.
    Enum: "DRAFT", "OPEN", "CANCELED"

  - `data.order.is_ghost` (boolean)
    Indicates if the order is a ghost order.
    Example: true

  - `data.order.fulfilled_at` (string,null)
    The date and time (ISO 8601 format) when the order was fulfilled.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.fulfillment_status` (string, required)
    The fulfillment status of the order.
    Enum: "FULFILLED", "UNFULFILLED"

  - `data.order.payment_status` (string, required)
    The payment status of the order.
    Enum: "PAID", "PARTIALLY_PAID", "UNPAID"

  - `data.order.internal_notes` (string,null)
    Internal order notes.
    Example: "Hey there notes!"

  - `data.order.currency` (string)
    The three-letter ISO 4217 currency code for the currency in which this order was or will be transacted. Must be a supported currency of Aryeo.
    Enum: "USD", "CAD", "GBP", "CHF", "EUR", "AUD", "NZD", "ZAR"

  - `data.order.total_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total order amount that was or will be charged. This accounts for order items and taxes.
    Example: 2099

  - `data.order.payment_url` (string,null)
    A URL of a publicly-accessible webpage to pay for the order.
    Example: "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order"

  - `data.order.status_url` (string,null, required)
    A URL of a publicly-accessible webpage to see the order's status.
    Example: "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status"

  - `data.order.invoice_url` (string,null)
    A URL of a publicly-accessible pdf invoice of the order.
    Example: "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download"

  - `data.order.downloads_allowed` (boolean, required)
    Indicates if the current user is allowed to download content from the attached listing.
    Example: true

  - `data.order.payments_allowed` (boolean, required)
    Indicates if the current user is allowed to make a payment for the order.
    Example: true

  - `data.order.address` (object)
    A street address and additional metadata about a location.

  - `data.order.address.latitude` (number,null)
    The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
    Example: 42.35157458574123

  - `data.order.address.longitude` (number,null)
    The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
    Example: -71.05763741484657

  - `data.order.address.street_number` (string,null)
    The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'.
    Example: "107"

  - `data.order.address.street_name` (string,null)
    The street name portion of a location's address.
    Example: "South St"

  - `data.order.address.unit_number` (string,null)
    The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.
    Example: "Unit 2F"

  - `data.order.address.postal_code` (string,null)
    The postal code portion of a location's address.
    Example: "02111"

  - `data.order.address.city` (string,null)
    The city of a location's address.
    Example: "Boston"

  - `data.order.address.city_region` (string,null)
    A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.
    Example: "Leather District"

  - `data.order.address.county_or_parish` (string,null)
    The County, Parish or other regional authority of the location.
    Example: "Suffolk County"

  - `data.order.address.state_or_province` (string,null)
    The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States.
    Example: "MA"

  - `data.order.address.state_or_province_region` (string,null)
    A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.
    Example: "Cape Cod"

  - `data.order.address.country` (string,null)
    The ISO 3166-1 country code for this for the country of the location.
    Example: "US"

  - `data.order.address.country_region` (string,null)
    A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.
    Example: "Napa Valley"

  - `data.order.address.timezone` (string,null)
    The assumed timezone the address is located in.
    Example: "America/New_York"

  - `data.order.address.unparsed_address` (string,null)
    Unparsed text representation of the address.
    Example: "107 South St, Boston MA, 02111"

  - `data.order.address.unparsed_address_part_one` (string,null)
    Unparsed text representation of the first part of the address, typically including the street number, street name, and unit number if applicable.
    Example: "107 South St, Unit 2F"

  - `data.order.address.unparsed_address_part_two` (string,null)
    Unparsed text representation of the second part of the address, typically including the city, state or province, and postal code.
    Example: "Boston, MA 02111"

  - `data.order.address.is_map_dirty` (boolean,null)
    Does this address need to be geocoded?
    Example: true

  - `data.order.customer` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.customer.type` (string, required)
    The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.
    Enum: "CREATOR", "AGENT", "BROKERAGE"

  - `data.order.customer.name` (string, required)
    The name of the group.
    Example: "John Doe Reality"

  - `data.order.customer.email` (string,null)
    The email address of a group.
    Example: "john.doe@gmail.com"

  - `data.order.customer.phone` (string,null)
    A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens).
    Example: "6175550173"

  - `data.order.customer.website_url` (string,null)
    The website URL of a group.
    Example: "https://www.aryeo.com"

  - `data.order.customer.logo_url` (string,null)
    The logo URL of a group.
    Example: "https://picsum.photos/300"

  - `data.order.customer.office_name` (string,null)
    The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT.
    Example: "John Doe Brokerage"

  - `data.order.customer.license_number` (string,null)
    The license number of a real estate agent. Only returned if group's type is AGENT.
    Example: "12345678"

  - `data.order.customer.timezone` (string,null)
    The default timezone for the group.
    Example: "America/New_York"

  - `data.order.customer.currency` (string)
    The default currency for the group.
    Enum: "USD", "CAD", "GBP", "CHF", "EUR", "AUD", "NZD", "ZAR", "DKK"

  - `data.order.customer.slug` (string,null)
    The slug for the group.
    Example: "example-photography"

  - `data.order.customer.order_page_url` (string,null)
    The order page URL for the group.
    Example: "https://example-photography.aryeo.com/order"

  - `data.order.customer.feature_flags` (array,null)
    An array of feature flags for the group.
    Enum: "alternate_unbranded_property_site_url", "avalara_tax_syncing", "avalara_taxes", "byop", "calendar_event_title_modified", "custom_field_uploads", "customer_teams_order_form_landing_page_override", "customer_teams_product_preselect", "customer_teams_external_payments", "customer_portal_mobile_app_automated_screenshots", "database_external_calendar_events", "default_reschedule_toggle_false", "idp_migration_in_progress", "listings_new_creation_flow", "min_hour_targets", "max_travel_distance", "order_form_categories", "require_photographer_confirmations", "showcase_order_form_visibility_designations", "team_member_restrictions", "team_member_hide_customer_pii", "virtual_staging_ai_v2", "virtual_staging_ai_v2_pricing", "virtuals1_custom_sms_notification_messages", "quickbooks_app", "webhooks", "zillow_3d_home", "zillow_streeteasy", "zillow_rentals"

  - `data.order.customer.order_page_background_color` (string,null)
    The background color for the order page (has a hex value) for the group.
    Example: "#FF0000"

  - `data.order.customer.social_profiles` (object,null)
    External profile URLs for an agent or brokerage group.

  - `data.order.customer.social_profiles.facebook_profile_url` (string,null)
    URL for Facebook.
    Example: "https://www.facebook.com/johndoe"

  - `data.order.customer.social_profiles.instagram_profile_url` (string,null)
    URL for Instagram.
    Example: "https://www.instagram.com/johndoe"

  - `data.order.customer.social_profiles.twitter_profile_url` (string,null)
    URL for Twitter.
    Example: "https://twitter.com/johndoe"

  - `data.order.customer.social_profiles.linkedin_profile_url` (string,null)
    URL for LinkedIn.
    Example: "https://www.linkedin.com/in/johndoe/"

  - `data.order.customer.social_profiles.zillow_profile_url` (string,null)
    URL for Zillow.
    Example: "https://www.zillow.com/profile/johndoe"

  - `data.order.customer.default_order_form` (object)
    An order form is a form that is used to submit an order.

  - `data.order.customer.default_order_form.title` (string, required)
    The title or name of the order form.
    Example: "BQ's Photography Order Form"

  - `data.order.customer.default_order_form.type` (string, required)
    The type of the order form, indicating whether the order form is an Aryeo order form or that of another scheduling service provider.
    Enum: "ARYEO", "EXTERNAL"

  - `data.order.customer.default_order_form.url` (string, required)
    A URL of a publicly-accessible webpage for this order form.
    Example: "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000"

  - `data.order.customer.default_order_form.is_public` (boolean)
    Indicates if the order form is publicly visible to all customers on the order form page
    Example: true

  - `data.order.customer.default_order_form.thumbnail_url` (string,null)
    A thumbnail image URL for the order form.
    Example: "https://picsum.photos/300"

  - `data.order.customer.default_order_form.use_territory_awareness` (boolean)
    Indicates if the order form is uses territories to filter available users and products.
    Example: true

  - `data.order.customer.default_order_form.availability_style` (string)
    The scheduling style the order form should use to for timeslot selection.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY", "DATETIME_PICKER"

  - `data.order.customer.default_order_form.slot_interval_minutes` (integer)
    How frequently slotted available times are on the order form.
    Example: 60

  - `data.order.customer.default_order_form.use_automated_user_assignment` (boolean)
    Indicates if the order form users auto-assignment of users to appointments.
    Example: true

  - `data.order.customer.default_order_form.automated_user_assignment_strategy` (string)
    The assignment strategy the order form should use to assign users to appointments, if applicable.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `data.order.customer.default_order_form.show_user_names` (boolean)
    Indicates if the order form should display user's names after they have been assigned to an appointment.
    Example: true

  - `data.order.customer.default_order_form.require_upfront_payment` (boolean)
    Indicates if the order form requires an upfront payment to place the order.
    Example: true

  - `data.order.customer.default_order_form.upfront_payment_percentage` (integer,null)
    The percentage of the order form's total price that should be paid upfront.
    Example: 50

  - `data.order.customer.default_order_form.use_instant_appointment_scheduling` (boolean)
    Indicates if the order form instantly schedules appointments as soon as the order is placed.
    Example: true

  - `data.order.customer.default_order_form.form_settings` (object)
    The settings for the order form.

  - `data.order.customer.default_order_form.owner` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.customer.default_order_form.company` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.customer.use_territory_awareness` (boolean,null)
    Indicates if the order form by default uses territories to filter available users and products.
    Example: true

  - `data.order.customer.availability_style` (string,null)
    The scheduling style the order form should use for timeslot selection by default.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY"

  - `data.order.customer.slot_interval_minutes` (integer,null)
    How frequently slotted available times are on the order form by default.
    Example: 60

  - `data.order.customer.use_automated_user_assignment` (boolean,null)
    Indicates if the order form uses auto-assignment of users to appointments.
    Example: true

  - `data.order.customer.automated_user_assignment_strategy` (string,null)
    The default assignment strategy the order form should use to assign users to appointments, if applicable.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `data.order.customer.show_user_names` (boolean,null)
    Indicates if the order form by default should display user's names after they have been assigned to an appointment.
    Example: true

  - `data.order.customer.use_instant_appointment_scheduling` (boolean,null)
    Indicates if the order form by default instantly schedules appointments as soon as the order is placed.
    Example: true

  - `data.order.customer.allow_order_cancellation` (boolean,null)
    If the group is a company, then this indicates if company allows customers to cancel orders or order items.
    Example: true

  - `data.order.customer.order_forms` (array,null)
    An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR.

  - `data.order.customer.owner` (object,null)
    A record of a person on the Aryeo platform.

  - `data.order.customer.owner.email` (string, required)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `data.order.customer.owner.first_name` (string,null)
    First name of the user.
    Example: "John"

  - `data.order.customer.owner.last_name` (string,null)
    Last name of the user.
    Example: "Doe"

  - `data.order.customer.owner.full_name` (string,null)
    The full name of the user.
    Example: "John Doe"

  - `data.order.customer.owner.internal_notes` (string,null)
    Internal notes for the user.
    Example: "Internal notes for the user."

  - `data.order.customer.owner.status` (string)
    The status of the user.
    Enum: "active", "inactive", "new", "sso"

  - `data.order.customer.owner.phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "123456789"

  - `data.order.customer.owner.avatar_url` (string,null)
    The avatar image URL of a user.
    Example: "https://picsum.photos/300"

  - `data.order.customer.owner.relationship` (string,null)
    Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group.
    Example: "owner"

  - `data.order.customer.owner.sso_users` (array)
    The list of SSO users associated with this user.

  - `data.order.customer.owner.sso_users.sso_id` (string, required)
    SSO ID of the user
    Example: "1234"

  - `data.order.customer.owner.sso_users.sso_provider` (object)
    A SSO Provider contains the information pertaining to the SSO connection.

  - `data.order.customer.owner.sso_users.sso_provider.name` (string, required)
    Name of the provider
    Example: "Some Company"

  - `data.order.customer.owner.sso_users.sso_provider.provider` (string, required)
    Technology of the provider
    Example: "Auth0"

  - `data.order.customer.owner.is_super` (boolean,null)
    Indicates if the user is a super user.
    Example: true

  - `data.order.customer.owner.verification_status` (string)
    The verification status of the user.
    Enum: "verified", "unverified", "new", "sso"

  - `data.order.customer.owner.password_expiration_days` (integer,null)
    The number of days until the user's password expires.
    Example: 30

  - `data.order.customer.owner.timezone` (string,null)
    The default timezone for the user.
    Example: "America/New_York"

  - `data.order.customer.owner.created_at` (string,null)
    The date and time (ISO 8601 format) when the user was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.customer.users` (array,null)
    The Aryeo users associated with this group.

  - `data.order.customer.is_brokerage_or_brokerage_agent` (boolean,null)
    Indicates if the group is a brokerage or brokerage agent.
    Example: true

  - `data.order.customer.internal_notes` (string,null)
    Internal notes about the group.
    Example: "Internal notes about the group."

  - `data.order.customer.team_members` (array,null)
    NOTE: Users do not have team members.

  - `data.order.customer.customer_group` (string,null)
    NOTE: Users do not have customer groups and they are deprecated.
    Example: "null"

  - `data.order.customer.custom_field_entries` (array,null)
    NOTE: Need to make a migration plan for this.

  - `data.order.customer.created_at` (string,null)
    The date and time the group was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.customer.has_restricted_photographers` (boolean,null)
    Whether the group is restricted from booking appointments with certain photographers.
    Example: true

  - `data.order.customer.is_payroll_enabled` (boolean,null)
    Indicates if the group has payroll enabled.
    Example: true

  - `data.order.customer.is_visible` (boolean,null)
    Indicates if the group is visible.
    Example: true

  - `data.order.customer.order_index` (integer,null)
    The order index of the group.
    Example: 1

  - `data.order.customer_group` (object)
    A customer group is a legacy name for what is now a customer team. A customer team is a container for customers, allowing you to apply settings such as price overrides and billing customer configurations in bulk.

  - `data.order.customer_group.name` (string, required)
    The name of the customer team.
    Example: "John Doe Customer Group"

  - `data.order.customer_group.description` (string,null)
    The description of the customer team.
    Example: "John Doe Customer Team is a customer team for John Doe."

  - `data.order.customer_group.internal_notes` (string,null)
    The internal notes of the customer team.
    Example: "John Doe's customer team normally doesn't work on Fridays."

  - `data.order.customer_group.logo_url` (string,null)
    The logo image URL of the customer team.
    Example: "https://picsum.photos/640/480"

  - `data.order.customer_group.brokerage_name` (string,null)
    The name of the brokerage team.
    Example: "Grimes-Mante"

  - `data.order.customer_group.brokerage_website` (string,null)
    The website URL of the brokerage team.
    Example: "http://www.tillman.info/aut-odio-qui-voluptatibus"

  - `data.order.customer_group.affiliate_id` (string,null)
    The affliate ID for the customer team.
    Example: "JOHN_DOE"

  - `data.order.customer_group.should_display_original_price` (boolean)
    Indicates if original prices should be displayed for this customer team.
    Example: true

  - `data.order.customer_group.should_disable_automated_payment_reminder_email` (boolean)
    Indicates if automated payment reminder emails should be disabled for this customer team.
    Example: true

  - `data.order.customer_group.should_lock_downloads_before_payment` (boolean,null)
    Indicates if the downloads should be locked before payment for this customer team.
    Example: true

  - `data.order.customer_group.order_form_id` (string,null)
    The ID of the order form.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.order.customer_group.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team was created.
    Example: "2025-03-07T13:59:03.000000Z"

  - `data.order.customer_group.is_showingtimeplus_team` (boolean)
    Indicates if the customer team is a ShowingTime team.
    Example: true

  - `data.order.customer_group.billing_customer` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.customer_group.billing_customer_pays_externally` (boolean)
    Indicates if the billing customer team membership pays externally.
    Example: true

  - `data.order.customer_group.status` (string)
    The status of the customer group.
    Enum: "any_status", "active", "archived"

  - `data.order.customer_group.is_archived` (boolean)
    Indicates if the customer group is archived.
    Example: true

  - `data.order.customer_group.website` (string,null)
    The website URL of the customer group.
    Example: "https://www.aryeo.com"

  - `data.order.customer_group.is_default` (boolean,null)
    Indicates if the customer group is the default customer group.
    Example: true

  - `data.order.customer_group.tags` (array)

  - `data.order.customer_group.tags.id` (string, required)
    ID. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.order.customer_group.tags.name` (string, required)
    The name of the tag.
    Example: "Photography"

  - `data.order.customer_group.tags.slug` (string, required)
    The slug of the tag.
    Example: "photography"

  - `data.order.customer_group.tags.color` (string, required)
    The background color of the tag.
    Example: "#8BC34A"

  - `data.order.customer_group.tags.font_color` (string, required)
    The font color of the tag.
    Example: "#FFFFFF"

  - `data.order.customer_group.tags.type` (string)
    The type of the tag.
    Enum: "order", "customer_team", "product", "order_form", "virtual_staging_ai"

  - `data.order.listing` (object)
    A real estate listing.

  - `data.order.listing.mls_number` (string,null)
    The identifier for a listing on its local MLS.
    Example: "1850209"

  - `data.order.listing.type` (string,null)
    General type of the listing, primarily categorizing its use case. Examples include residential and commercial.
    Enum: "BUSINESS_OPPORTUNITY", "COMMERCIAL_LEASE", "COMMERCIAL_SALE", "FARM", "LAND", "MANUFACTURED_IN_PARK", "RESIDENTIAL", "RESIDENTIAL_INCOME", "RESIDENTIAL_LEASE"

  - `data.order.listing.sub_type` (string,null)
    Further specifies the listing type. Examples include family residence and condominium.
    Enum: "APARTMENT", "CONDOMINIUM", "DUPLEX", "FARM", "SINGLE_FAMILY_RESIDENCE", "TIMESHARE", "TOWNHOUSE", "OFFICE"

  - `data.order.listing.status` (string,null)
    Local, regional, or otherwise custom status for the listing used by the parties involved in the listing transaction. While variable, these statuses are typically mapped to the listing's standard status.
    Enum: "DRAFT", "COMING_SOON", "FOR_SALE", "FOR_LEASE", "PENDING_SALE", "PENDING_LEASE", "FOR_RENT", "SOLD", "LEASED", "OFF_MARKET"

  - `data.order.listing.standard_status` (string,null)
    The status of the listing as it reflects the state of the contract between the listing agent and seller or an agreement with a buyer, including Active, Active Under Contract, Closed, Coming Soon, Hold, and Incomplete.
    Enum: "ACTIVE", "ACTIVE_UNDER_CONTRACT", "CLOSED", "COMING_SOON", "HOLD", "INCOMPLETE"

  - `data.order.listing.thumbnail_url` (string,null)
    A URL for a thumbnail representing the listing.
    Example: "https://picsum.photos/640/480"

  - `data.order.listing.large_thumbnail_url` (string,null)
    A URL for a large thumbnail representing the listing.
    Example: "https://picsum.photos/1280/960"

  - `data.order.listing.description` (string,null)
    Description of the selling points of the building and/or land for sale.
    Example: "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles."

  - `data.order.listing.lot` (object)
    Parcel data of the lot of a listing. Includes nearly everything about the land that makes up the listing.

  - `data.order.listing.lot.size_acres` (number,null)
    Total area of the lot of a listing in acres.
    Example: 0.47

  - `data.order.listing.lot.open_parking_spaces` (number,null)
    Number of parking spaces.
    Example: 3

  - `data.order.listing.building` (object)
    Structural data of the primary building on a listing. Includes everything from square footage of certain spaces to construction dates.

  - `data.order.listing.building.bedrooms` (integer,null)
    Total number of bedrooms.
    Example: 4

  - `data.order.listing.building.bathrooms` (number,null)
    Sum of the number of bathrooms. Represented as a number in order to support half-baths.
    Example: 3.5

  - `data.order.listing.building.square_feet` (number,null)
    Total number of square feet.
    Example: 2511

  - `data.order.listing.building.year_built` (integer,null)
    Year the property was built.
    Example: 1960

  - `data.order.listing.building.bedrooms_number` (number)
    Total number of bedrooms.
    Example: 4

  - `data.order.listing.price` (object)
    Valuation data relating to the price of a listing.

  - `data.order.listing.price.list_price` (integer,null)
    The current price of the listing.
    Example: 250000

  - `data.order.listing.price.list_price_formatted` (string,null)
    The current price of the listing formatted for display.
    Example: "$250,000"

  - `data.order.listing.list_agent` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.listing.co_list_agent` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.order.listing.customer_team_memberships` (array)
    customer_team_memberships

  - `data.order.listing.customer_team_memberships.role` (string, required)
    The role of the customer team membership.
    Enum: "admin", "member"

  - `data.order.listing.customer_team_memberships.invitation_accepted_at` (string,null)
    The date and time (ISO 8601 format) when the invitation was accepted.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.customer_team_memberships.status` (string, required)
    The status of the customer team membership.
    Enum: "deleted", "archived", "revoked", "active", "invited"

  - `data.order.listing.customer_team_memberships.customer_team` (object)
    A customer group is a legacy name for what is now a customer team. A customer team is a container for customers, allowing you to apply settings such as price overrides and billing customer configurations in bulk.

  - `data.order.listing.customer_team_memberships.is_active` (boolean)
    Whether the customer team membership is active.
    Example: true

  - `data.order.listing.customer_team_memberships.is_archived` (boolean)
    Whether the customer team membership is archived.
    Example: true

  - `data.order.listing.customer_team_memberships.is_deleted` (boolean)
    Whether the customer team membership is deleted.
    Example: true

  - `data.order.listing.customer_team_memberships.is_invited` (boolean)
    Whether the customer team membership is invited.
    Example: true

  - `data.order.listing.customer_team_memberships.is_default` (boolean)
    Whether the customer team membership is the default.
    Example: true

  - `data.order.listing.customer_team_memberships.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team membership was created.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.customer_team_memberships.customer_user` (object)
    A record of a customer on the Aryeo platform.

  - `data.order.listing.customer_team_memberships.customer_user.name` (string,null)
    Name of the user.
    Example: "John"

  - `data.order.listing.customer_team_memberships.customer_user.logo_url` (string,null)
    The logo URL of a user.
    Example: "https://picsum.photos/300"

  - `data.order.listing.customer_team_memberships.customer_user.timezone` (string,null)
    The default timezone for the customer.
    Example: "America/New_York"

  - `data.order.listing.customer_team_memberships.customer_user.customer_team_memberships` (array)

  - `data.order.listing.customer_team_memberships.customer_user.created_at` (string)
    The date and time (ISO 8601 format) when the customer record was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.customer_team_memberships.customer_user.is_visible` (boolean,null)
    Indicates if the customer is visible.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.order_index` (integer,null)
    The order index of the customer.
    Example: 1

  - `data.order.listing.customer_team_memberships.customer_user.verification_status` (string)
    The verification status of the customer.
    Enum: "verified", "unverified", "new", "sso"

  - `data.order.listing.customer_team_memberships.customer_user.credit_balance_amount` (number,null)
    The credit balance amount of the customer.
    Example: 100

  - `data.order.listing.customer_team_memberships.customer_user.total_balance_amount` (number,null)
    The total balance amount of the customer.
    Example: 100

  - `data.order.listing.customer_team_memberships.customer_user.is_showingtimeplus_user` (boolean)
    Whether the customer is a ShowingTime+ user.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.full_name` (string)
    The full name of the customer.
    Example: "John Doe"

  - `data.order.listing.customer_team_memberships.customer_user.first_name` (string)
    The first name of the customer.
    Example: "John"

  - `data.order.listing.customer_team_memberships.customer_user.last_name` (string)
    The last name of the customer.
    Example: "Doe"

  - `data.order.listing.customer_team_memberships.customer_user.phone_number` (string,null)
    The phone number of the customer.
    Example: "1234567890"

  - `data.order.listing.customer_team_memberships.customer_user.profile_link` (string,null)
    The profile link of the customer.
    Example: "https://picsum.photos/300"

  - `data.order.listing.customer_team_memberships.customer_user.internal_notes` (string,null)
    The internal notes of the customer.
    Example: "John Doe is a customer."

  - `data.order.listing.customer_team_memberships.customer_user.agent_company_name` (string,null)
    The agent company name of the customer.
    Example: "John Doe Real Estate"

  - `data.order.listing.customer_team_memberships.customer_user.agent_license_number` (string,null)
    The agent license number of the customer.
    Example: "1234567890"

  - `data.order.listing.customer_team_memberships.customer_user.is_blocked_from_ordering` (boolean)
    Whether the customer is blocked from ordering.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.has_restricted_photographers` (boolean)
    Whether the customer is restricted from booking appointments with certain photographers.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.default_lock_downloads_before_payment` (boolean,null)
    Whether the customer has locked media downloads before payment as the default download setting.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.default_allows_access_to_marketing_material` (boolean,null)
    Whether the customer has access to the marketing material builder.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.avalara_customer_code` (string,null)
    The Avalara customer code of the customer.
    Example: "1234567890"

  - `data.order.listing.customer_team_memberships.customer_user.quickbooks_customer_id` (string,null)
    The Quickbooks customer ID of the customer.
    Example: "1234567890"

  - `data.order.listing.customer_team_memberships.customer_user.is_super` (boolean)
    Whether the customer is a super user.
    Example: true

  - `data.order.listing.customer_team_memberships.customer_user.status` (string)
    The status of the customer.
    Enum: "active", "inactive", "new", "sso"

  - `data.order.listing.customer_team_memberships.listing_delivery_notification_enabled` (boolean)
    Whether the customer team membership has listing delivery notifications enabled.
    Example: true

  - `data.order.listing.customer_team_memberships.is_showingtimeplus_workspace_membership` (boolean)
    Whether the customer team membership is a ShowingTime workspace membership.
    Example: true

  - `data.order.listing.customer_team_memberships.is_visible` (boolean,null)
    Whether the customer team membership is visible.
    Example: true

  - `data.order.listing.customer_team_memberships.order_index` (integer,null)
    The order index of the customer team membership.
    Example: 1

  - `data.order.listing.images` (array)
    images

  - `data.order.listing.images.thumbnail_url` (string, required)
    A URL for a thumbnail-sized version of the image.
    Example: "https://picsum.photos/250/200"

  - `data.order.listing.images.large_url` (string, required)
    A URL for a large version of the image.
    Example: "https://picsum.photos/1750/1400"

  - `data.order.listing.images.filename` (string, required)
    The name of the file.
    Example: "image.jpg"

  - `data.order.listing.images.original_url` (string, required)
    A URL for the original, full-resolution version of the image. Useful for downloading.
    Example: "https://picsum.photos/2500/2000"

  - `data.order.listing.images.index` (integer,null)
    The order in which the image should be displayed amongst other related images.
    Example: 2

  - `data.order.listing.images.caption` (string,null)
    A brief explanation of the image.
    Example: "This is the front of the house."

  - `data.order.listing.images.display_in_gallery` (boolean, required)
    Should the image be displayed in a gallery?
    Example: true

  - `data.order.listing.files` (array)
    files

  - `data.order.listing.files.uuid` (string, required)
    UUID of the file (duplicate of id in legacy contexts).
    Example: "0197f537-84c8-7329-b833-e28cd814a1ce"

  - `data.order.listing.files.filename` (string, required)
    The file's name or key.
    Example: "f7149b39-c3bf-47a1-b023-2f2e476ed0e5"

  - `data.order.listing.files.file_type` (string, required)
    The file type or extension.
    Example: "jpg"

  - `data.order.listing.files.description` (string,null)
    A description of the file.
    Example: "Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad."

  - `data.order.listing.files.display_type` (string,null)
    How this file should be displayed in the UI.
    Enum: "none", "both"

  - `data.order.listing.files.url` (string, required)
    A URL to access or download the file.
    Example: "https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg"

  - `data.order.listing.videos` (array)
    videos

  - `data.order.listing.videos.title` (string,null)
    The title of the video given by the uploading user.
    Example: "The New Vimeo Player (You Know, For Videos)"

  - `data.order.listing.videos.duration` (integer,null)
    The video's runtime in seconds.
    Example: 360

  - `data.order.listing.videos.display_type` (string, required)
    The display type determines if the video is branded or unbranded (can also be none or both). This affects whether the video is displayed on branded or unbranded marketing materials such as the property website.
    Enum: "BRANDED", "UNBRANDED", "BOTH", "NONE"

  - `data.order.listing.videos.source_type` (string, required)
    The original upload source of the video, used to determine how to handle the playback_url of the video and other display properties.
    Enum: "YOUTUBE", "VIMEO", "OPTIMIZED", "UPLOADED", "LINK"

  - `data.order.listing.videos.thumbnail_url` (string, required)
    A thumbnail image URL for the video.
    Example: "https://picsum.photos/300"

  - `data.order.listing.videos.playback_url` (string,null, required)
    A URL linking to playback stream of the video.
    Example: "https://player.vimeo.com/video/76979871"

  - `data.order.listing.videos.download_url` (string,null)
    A URL for downloading the video.
    Example: "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4"

  - `data.order.listing.videos.share_url` (string,null)
    A URL linking to a public viewing optimized webpage the video.
    Example: "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1"

  - `data.order.listing.floor_plans` (array)
    floor_plans

  - `data.order.listing.floor_plans.original_url` (string, required)
    A URL for the original, full-resolution version of the floor plan. Useful for downloading.
    Example: "https://picsum.photos/2500/2000"

  - `data.order.listing.floor_plans.large_url` (string, required)
    A URL for a large version of the floor plan.
    Example: "https://picsum.photos/1750/1400"

  - `data.order.listing.floor_plans.thumbnail_url` (string, required)
    A URL for a thumbnail-sized version of the floor plan.
    Example: "https://picsum.photos/250/200"

  - `data.order.listing.floor_plans.title` (string,null)
    The title (or caption) of the floor plan.
    Example: "Downstairs floorplan"

  - `data.order.listing.floor_plans.index` (integer,null)
    Index order position of the floor plan.
    Example: 1

  - `data.order.listing.interactive_content` (array)
    interactive_content

  - `data.order.listing.interactive_content.title` (string,null)
    The title of the interactive content given by the uploading user.
    Example: "My Matterport"

  - `data.order.listing.interactive_content.display_type` (string, required)
    Is the content branded, unbranded, or both?
    Enum: "BRANDED", "UNBRANDED", "BOTH"

  - `data.order.listing.interactive_content.content_type` (string, required)
    The type of interactive content.
    Enum: "MATTERPORT", "OTHER"

  - `data.order.listing.interactive_content.url` (string, required)
    URL for the content.
    Example: "https://my.matterport.com/show/?m=HFaxPzqNFfm"

  - `data.order.listing.interactive_content.thumbnail_url` (string,null)
    A URL for a thumbnail-sized preview of the content.
    Example: "https://picsum.photos/300"

  - `data.order.listing.property_website` (object)
    Website (in branded and unbranded versions) that displays information about a property.

  - `data.order.listing.property_website.branded_url` (string, required)
    URL for branded version of website.
    Example: "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded"

  - `data.order.listing.property_website.unbranded_url` (string, required)
    URL for unbranded version of website.
    Example: "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"

  - `data.order.listing.marketing_materials` (array)
    Marketing materials for this listing.

  - `data.order.listing.marketing_materials.id` (string,null)
    The ID of the marketing material. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.order.listing.marketing_materials.name` (string,null)
    The name of the marketing material.
    Example: "New marketing material"

  - `data.order.listing.marketing_materials.thumbnail_url` (string,null)
    A URL for a thumbnail-sized preview of the marketing material.
    Example: "https://picsum.photos/250/200"

  - `data.order.listing.marketing_materials.published_at` (string,null)
    The date and time (ISO 8601 format) when the marketing material record was last published.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.marketing_materials.polotno_json` (object)
    The JSON representation of a Polotno canvas.

  - `data.order.listing.marketing_materials.polotno_json.width` (integer, required)
    The width of the canvas.
    Example: 500

  - `data.order.listing.marketing_materials.polotno_json.height` (integer, required)
    The height of the canvas.
    Example: 500

  - `data.order.listing.marketing_materials.listing_download_hash` (string,null)
    The ID of the listing the marketing material belongs to. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.order.listing.marketing_materials.json_updated_at` (number,null)
    Timestamp of when the polotno_json field was last updated.
    Example: 1624057368000

  - `data.order.listing.marketing_materials.exports` (array)

  - `data.order.listing.marketing_materials.exports.uuid` (string,null, required)
    Unique identifier for the export.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.order.listing.marketing_materials.exports.key` (string,null, required)
    Key identifier for the export.
    Example: "export-123"

  - `data.order.listing.marketing_materials.exports.file_path` (string, required)
    Path to the exported file.
    Example: "https://aryeo.sfo2.cdn.digitaloceanspaces.com/marketing-material-templates/sirius-template-preview.jpg"

  - `data.order.listing.marketing_materials.exports.content_type` (string,null, required)
    MIME type of the exported file.
    Example: "application/pdf"

  - `data.order.listing.marketing_materials.exports.extension` (string,null, required)
    File extension of the exported file.
    Example: "pdf"

  - `data.order.listing.esoft_order_lines` (array)
    Esoft order lines for this listing.

  - `data.order.listing.esoft_order_lines.esoft_order_line_id` (string,null)
    The Esoft order line ID from coconut.
    Example: 6141841

  - `data.order.listing.esoft_order_lines.client_id` (string,null)
    The Esoft client ID.
    Example: 701334

  - `data.order.listing.esoft_order_lines.reference` (string)
    The Esoft order refrence.
    Example: "123 Main St"

  - `data.order.listing.esoft_order_lines.status` (enum)
    The Esoft order status.
    Enum: "complete", "cancelled", "draft", "error", "submitted"

  - `data.order.listing.esoft_order_lines.esoft_product_id` (number)
    The Esoft product ID.
    Example: 700012

  - `data.order.listing.esoft_order_lines.esoft_product_name` (string)
    The Esoft product name.
    Example: "Standard Photo Editing"

  - `data.order.listing.esoft_order_lines.esoft_product_variant` (string)
    The Esoft product variant.
    Example: "PH_VT"

  - `data.order.listing.esoft_order_lines.quantity` (number)
    The quantity of the Esoft product ordered (varies by product and company).
    Example: 10

  - `data.order.listing.esoft_order_lines.comments` (string,null)
    The Esoft order comments.
    Example: "Please add a watermark to the photos."

  - `data.order.listing.orders` (array)
    orders

  - `data.order.listing.appointments` (array)

  - `data.order.listing.appointments.status` (string,null)
    The status of the appointment.
    Enum: "SCHEDULED", "UNSCHEDULED", "CANCELED"

  - `data.order.listing.appointments.title` (string,null)
    The title of the appointment.
    Example: "Appointment title"

  - `data.order.listing.appointments.description` (string,null)
    The multi-line description of the appointment.
    Example: "Customer: John Doe\nOrder Details: Order #123"

  - `data.order.listing.appointments.start_at` (string,null)
    The date and time (ISO 8601 format) when the appointment is set to start.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.end_at` (string,null)
    The date and time (ISO 8601 format) when the appointment is set to end.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.rescheduled_at` (string,null)
    The date and time (ISO 8601 format) when the appointment was rescheduled.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.postponed_at` (string,null)
    The date and time (ISO 8601 format) when the appointment was postponed.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.previous_start_at` (string,null)
    The date and time (ISO 8601 format) when the appointment was previously scheduled for.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.preference_type` (string,null)
    The type of preferred scheduling information provided by a customer to aid in scheduling this appointment.
    Enum: "ASAP", "TIME", "TIME_OF_DAY", "NONE"

  - `data.order.listing.appointments.preferred_start_at` (string,null)
    A preferred date and time (ISO 8601 format) for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.preferred_start_at_day` (string,null)
    A preferred date (ISO 8601 format) for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME_OF_DAY.
    Example: "2021-06-30"

  - `data.order.listing.appointments.preferred_start_at_time_of_day` (string,null)
    A preferred time of day for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME_OF_DAY.
    Enum: "MORNING", "MIDDAY", "AFTERNOON", "TWILIGHT"

  - `data.order.listing.appointments.duration` (integer,null)
    The length of the appointment in minutes.
    Example: 60

  - `data.order.listing.appointments.user_has_appointments_manage_permission` (boolean)
    Does the authorized user have the availability to manage this appointment?
    Example: true

  - `data.order.listing.appointments.users` (array,null)
    Users attached to the appointment.

  - `data.order.listing.appointments.items` (array)
    Items attached to the appointment.

  - `data.order.listing.appointments.items.title` (string)
    The title of the item.
    Example: "Aerial Video"

  - `data.order.listing.appointments.items.subtitle` (string)
    The sub title of the item.
    Example: "10 minute video"

  - `data.order.listing.appointments.items.sub_title` (string)
    The sub title of the item.
    Example: "10 minute video"

  - `data.order.listing.appointments.items.description` (string)
    The description of the item.
    Example: "A fly-by drone video of the property."

  - `data.order.listing.appointments.items.purchasable_type` (string)
    The type of order item.
    Enum: "PRODUCT_VARIANT", "FEE", "CUSTOM"

  - `data.order.listing.appointments.items.amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged. Legacy version of unit_price_amount.
    Example: 2099

  - `data.order.listing.appointments.items.unit_price_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged.
    Example: 2099

  - `data.order.listing.appointments.items.quantity` (integer)
    A positive integer representing the number of instances of this item that was or will be serviced.
    Example: 2

  - `data.order.listing.appointments.items.gross_total_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total cost of this item (before discounts and taxes have been applied) to be charge.
    Example: 4198

  - `data.order.listing.appointments.items.appointment` (object)
    An appointment.

  - `data.order.listing.appointments.items.discounts` (array)

  - `data.order.listing.appointments.items.discounts.discount` (object)
    A discount represents the application of a coupon to an order or order item. It includes the calculated amount to be discounted based on the coupon configuration.

  - `data.order.listing.appointments.items.discounts.discount.total_discount_amount` (integer)
    The total discount amount.
    Example: 1000

  - `data.order.listing.appointments.items.discounts.discount.coupon` (object)
    A coupon contains information about a percent-off or amount-off discount you might want to apply to an order.

  - `data.order.listing.appointments.items.discounts.discount.coupon.name` (string)
    Name of the coupon displayed to customers on orders.
    Example: "VIP Customer Discount"

  - `data.order.listing.appointments.items.discounts.discount.coupon.is_active` (boolean)
    Indicates if the coupon is currently active.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.is_percent_off` (boolean)
    Indicates if the coupon is a percent off coupon.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.percent_off` (number)
    A decimal value representing the percent that will be taken off the subtotal of an order this coupon is applied to. For example, 0.500 would represent an applied discount of 50%, meaning an order with a subtotal of $100 would result in a balance of $50.
    Example: 0.075

  - `data.order.listing.appointments.items.discounts.discount.coupon.amount_off` (integer)
    Amount that will be taken off the subtotal of any orders this coupon is applied to. Amount represented in the smallest currency unit (that is, 100 cents for $1.00).
    Example: 2500

  - `data.order.listing.appointments.items.discounts.discount.coupon.amount_off_formatted` (string)
    The amount off formatted as a string.
    Example: "$25.00"

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes` (array)

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.code` (string, required)
    The customer-facing code. This code must be unique across all active promotion codes.
    Example: "SPRING_SALE"

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.times_redeemed` (integer)
    The number of times the coupon has been redeemed.
    Example: 10

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.start_at` (string,null)
    The date and time (ISO 8601 format) when the promotion code will be active.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.end_at` (string,null)
    The date and time (ISO 8601 format) when the promotion code will no longer be active.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.max_redemptions` (integer,null)
    The maximum number of times the promotion code can be redeemed.
    Example: 10

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.max_redemptions_per_customer` (integer,null)
    The maximum number of times the promotion code can be redeemed per customer.
    Example: 10

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.first_time_only` (boolean,null)
    Indicates if the promotion code can only be redeemed once per customer.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.minimum_amount` (integer,null)
    The minimum amount that must be in the cart before the promotion code can be applied.
    Example: 1000

  - `data.order.listing.appointments.items.discounts.discount.coupon.promotion_codes.is_portal_mobile_app_only` (boolean,null)
    Indicates if the promotion code can only be redeemed on the portal mobile app.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables` (array)

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.object` (string)
    String representing the object’s type. Objects of the same type share the same schema.
    Example: "DISCOUNTABLE"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable` (object)
    A discountable item.

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.active` (boolean)
    The active status of an item.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.type` (string)
    The type of item.
    Example: "MAIN"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.is_twilight` (boolean)
    Whether the item is available during twilight hours.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.image_url` (string,null)
    A URL for an example property image.
    Example: "https://picsum.photos/400/200"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.is_serviceable` (boolean)
    Whether the item is serviceable.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.requires_separate_booking` (boolean)
    Whether the item requires a separate booking.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.always_display_addons` (boolean)
    Whether to always display addons for the item.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variant_filter_type` (string,null)
    The type of variant filter.
    Example: "ALL"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.avalara_tax_code` (string,null)
    The Avalara tax code for the item.
    Example: "12345"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.limit_quantity_amount` (integer,null)
    The limit quantity amount for the item.
    Example: 10

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.limit_quantity` (boolean)
    Whether the item has a limit quantity.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.is_filterable` (boolean)
    Whether the item is filterable.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.is_esoft_adjustment` (boolean)
    Whether the item is an eSoft adjustment.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants` (array)

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.title` (string, required)
    The title of the product variant.
    Example: "House photos"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.price` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.price_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.base_price_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant.
    Example: 10000

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.base_is_hidden` (boolean)
    Indicates if the base price of the product variant is hidden.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.display_original_price` (boolean)
    Indicates if the original price of the product variant should be displayed.
    Example: true

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.variants.duration` (integer)
    The duration of the product item, in minutes.
    Example: 60

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories` (array)

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories.title` (string, required)
    The title of the product category.
    Example: "Photography"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories.name` (string)
    The name of the product category.
    Example: "Photography"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories.slug` (string)
    The slug of the product category.
    Example: "photography"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories.color` (string)
    The color of the product category.
    Example: "#000000"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.categories.type` (string)
    The type of the product category.
    Example: "product"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.quickbooks_item_id` (string,null)
    The Quickbooks item ID for the item.
    Example: "12345"

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.amount` (number)
    The amount of the item.
    Example: 100

  - `data.order.listing.appointments.items.discounts.discount.coupon.discountables.discountable.name` (string)
    The name of the item.
    Example: "Flat Fee"

  - `data.order.listing.appointments.items.discounts.discount.coupon.created_at` (string,null)
    The date and time (ISO 8601 format) when the order was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.items.discounts.amount` (integer)
    The amount of discount that was applied
    Example: 2999

  - `data.order.listing.appointments.items.discounts.applied_percent_off` (number,null)
    Representation of percent off ranging from 0 to 1
    Example: 0.2

  - `data.order.listing.appointments.items.discounts.applied_amount_off` (integer,null)
    Amount discounted in cents
    Example: 2500

  - `data.order.listing.appointments.items.product` (object)
    A product available for purchase via an order.

  - `data.order.listing.appointments.items.product.title` (string, required)
    The title of the product.
    Example: "House photos"

  - `data.order.listing.appointments.items.product.description` (string)
    The description of the product.
    Example: "Capture photos of a house for sale."

  - `data.order.listing.appointments.items.product.active` (boolean)
    The active status of a product.
    Example: true

  - `data.order.listing.appointments.items.product.type` (string, required)
    The type of product.
    Enum: "MAIN", "ADDON"

  - `data.order.listing.appointments.items.product.is_twilight` (boolean)
    Whether the product is available during twilight hours.
    Example: true

  - `data.order.listing.appointments.items.product.is_serviceable` (boolean)
    Whether the product is serviceable.
    Example: true

  - `data.order.listing.appointments.items.product.requires_separate_booking` (boolean)
    Whether the product requires a separate booking.
    Example: true

  - `data.order.listing.appointments.items.product.always_display_addons` (boolean)
    Whether to always display addons for the product.
    Example: true

  - `data.order.listing.appointments.items.product.avalara_tax_code` (string,null)
    The Avalara tax code for the product.
    Example: "12345"

  - `data.order.listing.appointments.items.product.limit_quantity_amount` (integer,null)
    The limit quantity amount for the product.
    Example: 10

  - `data.order.listing.appointments.items.product.limit_quantity` (boolean)
    Whether the product has a limit quantity.
    Example: true

  - `data.order.listing.appointments.items.product.is_filterable` (boolean)
    Whether the product is filterable.
    Example: true

  - `data.order.listing.appointments.items.product.is_esoft_adjustment` (boolean)
    Whether the product is an eSoft adjustment.
    Example: true

  - `data.order.listing.appointments.items.product_variant` (object)
    A variant of a product.

  - `data.order.listing.appointments.items.taxes` (array)

  - `data.order.listing.appointments.items.taxes.object` (string, required)
    String representing the object's type.
    Example: "TAX"

  - `data.order.listing.appointments.items.taxes.total_tax_amount` (integer)
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total calculated tax for this tax rate for all applicable order items.
    Example: 2099

  - `data.order.listing.appointments.items.taxes.applied_rate` (number)
    A decimal value representing the rate of the parent tax rate at the time of this tax application. For example, 0.075 would represent an applied tax percentage of 7.5%.
    Example: 0.075

  - `data.order.listing.appointments.items.taxes.tax_rate` (object)
    A tax rate represents the percentage of tax that should be applied to a taxed entity.

  - `data.order.listing.appointments.items.taxes.tax_rate.name` (string)
    The name of the tax.
    Example: "New York State Tax"

  - `data.order.listing.appointments.items.taxes.tax_rate.description` (string,null)
    The description of the tax rate.
    Example: "Tax rate applied for any property that falls within the bounds New York State."

  - `data.order.listing.appointments.items.taxes.tax_rate.applied_rate` (number)
    A decimal value representing the rate that should be applied to a taxed entity. For example, 0.075 would represent an applied tax percentage of 7.5%.
    Example: 0.075

  - `data.order.listing.appointments.items.taxes.tax_rate.rate` (string,null)
    A decimal value representing the rate that should be applied to a taxed entity. For example, 0.075 would represent an applied tax percentage of 7.5%.
    Example: "0.075000"

  - `data.order.listing.appointments.items.taxes.tax_rate.is_active` (boolean)
    Whether the tax rate is active.
    Example: true

  - `data.order.listing.appointments.items.taxes.tax_rate.is_inclusive` (boolean)
    Whether the tax rate is inclusive.
    Example: true

  - `data.order.listing.appointments.items.is_serviceable` (boolean)
    Whether the order item is serviceable.
    Example: true

  - `data.order.listing.appointments.items.tasks` (array)
    The tasks associated with the order item.

  - `data.order.listing.appointments.items.tasks.name` (string, required)
    The name of the task.
    Example: "Complete 41 Drone Shots, Variant corporis"

  - `data.order.listing.appointments.items.tasks.description` (string,null)
    Detailed description of the task
    Example: "Complete 41 Drone Shots, Variant corporis"

  - `data.order.listing.appointments.items.tasks.quantity` (integer,null)
    Number of items or units for this task
    Example: 1

  - `data.order.listing.appointments.items.tasks.pay_run_item_amount` (number,null)
    Payment amount associated with this task
    Example: 10000

  - `data.order.listing.appointments.items.tasks.due_at` (string,null)
    Deadline for task completion
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.items.tasks.completed_at` (string,null)
    When the task was completed
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.items.tasks.is_completed` (boolean, required)
    Flag indicating whether the task is completed
    Example: true

  - `data.order.listing.appointments.items.is_canceled` (boolean)
    Whether the order item is canceled.
    Example: true

  - `data.order.listing.appointments.can_cancel` (boolean,null)
    Indicates if the request user can cancel the appointment.
    Example: true

  - `data.order.listing.appointments.can_reschedule` (boolean,null)
    Indicates if the request user can reschedule the appointment.
    Example: true

  - `data.order.listing.appointments.is_within_cancellation_lock_period` (boolean,null)
    Indicates if the appointment is within the cancellation lock period.
    Example: true

  - `data.order.listing.appointments.is_within_rescheduling_lock_period` (boolean,null)
    Indicates if the appointment is within the cancellation lock period.
    Example: true

  - `data.order.listing.appointments.deleted_at` (string,null)
    A deleted date and time (ISO 8601 format) for when we use a filter to get changed appointments.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.requires_confirmation` (boolean,null)
    Indicates if the appointment requires confirmation.
    Example: true

  - `data.order.listing.appointments.late_cancellation_fee` (array)
    The late cancellation fee for the appointment.

  - `data.order.listing.appointments.updated_at` (string,null)
    The date and time (ISO 8601 format) when the appointment was last updated.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.listing.appointments.company_team_members` (array)
    The team members associated with the appointment.

  - `data.order.listing.appointments.company_team_members.calendar_color` (string,null)
    Color code for calendar display, if assigned
    Example: "#FF0000"

  - `data.order.listing.appointments.company_team_members.permissions` (array, required)
    List of permissions granted to the team member

  - `data.order.listing.appointments.company_team_members.permissions.name` (string, required)
    The name of the permission
    Enum: "ACTIVITY_LOG_VIEW", "APP_STORE_VIEW_ANY", "APPOINTMENTS_MANAGE", "AVAILABILITY_VIEW_ANY", "CALENDAR_VIEW_ANY", "CUSTOMER_CREATE", "CUSTOMER_DELETE", "CUSTOMER_EXPORT_CREATE", "CUSTOMER_IMPORT_CREATE", "CUSTOMER_VIEW_ANY", "FEE_VIEW_ANY", "LISTING_CREATE", "LISTING_DELETE", "LISTING_VIEW_ANY", "MEDIA_REQUEST_MANAGE", "ORDER_AMOUNT_VIEW_ANY", "ORDER_FORM_VIEW_ANY", "ORDER_NOTES_MANAGE", "ORDER_VIEW_ANY", "ORDERS_MANAGE", "PAYMENT_METHODS_MANAGE", "PAYROLL_MANAGE", "PAYROLL_PERSONAL_MANAGE", "PAYROLL_PERSONAL_VIEW", "PRODUCT_VIEW_ANY", "REPORT_VIEW_ANY", "SETTINGS_MANAGE", "TAX_VIEW_ANY", "TERRITORY_VIEW_ANY", "ZILLOW_MEDIA_EXCLUSIVES_MANAGE"

  - `data.order.listing.appointments.company_team_members.restrictions` (array, required)
    List of restrictions applied to the team member

  - `data.order.listing.appointments.company_team_members.is_service_provider` (boolean, required)
    Indicates if the team member is a service provider
    Example: true

  - `data.order.listing.appointments.company_team_members.external_id` (string,null)
    External identifier for the team member, if any
    Example: "1234567890"

  - `data.order.listing.appointments.company_team_members.company_user` (object,null)
    A record of a person on the Aryeo platform.

  - `data.order.listing.appointments.company_team_members.has_owner_role` (boolean,null)
    Indicates if the team member has the owner role
    Example: true

  - `data.order.listing.appointments.company_team_members.is_owner` (boolean,null)
    Indicates if the team member is the owner
    Example: true

  - `data.order.listing.appointments.company_team_members.invitation_accepted_at` (string,null)
    The date and time (ISO 8601 format) when the company team member invitation was accepted
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.appointments.company_team_members.role` (string,null)
    The role of the team member
    Enum: "ADMIN", "MEMBER", "OWNER"

  - `data.order.listing.appointments.company_team_members.status` (string,null)
    The status of the team member
    Enum: "active", "invited", "revoked"

  - `data.order.listing.appointments.company_team_members.is_active` (boolean,null)
    Indicates if the team member is active
    Example: true

  - `data.order.listing.appointments.company_team_members.is_invited` (boolean,null)
    Indicates if the team member is invited
    Example: true

  - `data.order.listing.appointments.company_team_members.is_revoked` (boolean,null)
    Indicates if the team member is revoked
    Example: true

  - `data.order.listing.appointments.company_team_members.scheduling_priority` (integer,null)
    The scheduling priority of the team member
    Example: 1

  - `data.order.listing.appointments.company_team_members.created_at` (string,null)
    The date and time (ISO 8601 format) when the company team member was created
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.appointments.company_team_members.require_appointment_confirmation` (boolean,null)
    Indicates if the team member requires appointment confirmation
    Example: true

  - `data.order.listing.appointments.appointment_attendances` (array)
    The attendances associated with the appointment.

  - `data.order.listing.appointments.appointment_attendances.id` (number,null, required)
    ID of the appointment attendance.
    Example: 1234567890

  - `data.order.listing.appointments.appointment_attendances.company_team_member` (object, required)
    A team member of a company.

  - `data.order.listing.appointments.appointment_attendances.zillow_3d_home_deep_link_url` (string,null)
    URL to Zillow 3D home tour if available
    Example: "https://aryeo.com"

  - `data.order.listing.appointments.appointment_attendances.is_requested` (boolean, required)
    Indicates if attendance was requested
    Example: true

  - `data.order.listing.appointments.appointment_attendances.accepted_at` (string,null)
    The date and time (ISO 8601 format) when attendance was accepted.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.appointments.appointment_attendances.declined_at` (string,null)
    The date and time (ISO 8601 format) when attendance was declined.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.order.listing.unconfirmed_appointments` (array)

  - `data.order.listing.downloads_enabled` (boolean, required)
    Are downloads enabled for this listing?
    Example: true

  - `data.order.listing.is_showcase` (boolean)
    Indicates if this is a Showcase listing
    Example: true

  - `data.order.listing.is_showcasable` (boolean)
    Indicates if this listing can be showcased
    Example: true

  - `data.order.listing.has_high_resolution_images` (boolean)
    Indicates if this listing has high resolution images
    Example: true

  - `data.order.listing.has_zillow_imx_tour` (boolean)
    Indicates if this listing has a Zillow IMX tour
    Example: true

  - `data.order.listing.delivery_status` (string,null)
    The delivery status of the listing.
    Enum: "DELIVERED", "UNDELIVERED", "SCHEDULED"

  - `data.order.order_form` (object)
    An order form is a form that is used to submit an order.

  - `data.order.discounts` (array)
    The list of discounts applied to the order.

  - `data.order.tags` (array)
    The list of tags applied to the order.

  - `data.order.items` (array)
    items

  - `data.order.custom_items` (array,null)
    The list of custom items applied to the order.

  - `data.order.updated_at` (string,null, required)
    The date and time (ISO 8601 format) when the order was last updated.
    Example: "2021-06-30T20:30:00Z"

  - `data.order.custom_fields` (array,null)
    The list of custom fields applied to the order.

  - `data.order.taxes` (array)
    The list of taxes applied to the order.

  - `data.order.booking_limits` (object)
    Booking limits and scheduling configuration

  - `data.order.booking_limits.is_twilight_visible` (boolean,null, required)
    Whether twilight hours are visible
    Example: true

  - `data.order.filter_by_square_feet` (boolean,null)
    Indicates if the order should be filtered by square feet.
    Example: true

  - `data.order.filter_by_list_price` (boolean,null)
    Indicates if the order should be filtered by list price.
    Example: true

  - `data.order.scheduling_assignment_strategy` (string,null)
    The strategy used for scheduling assignment.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `data.order.balance_amount` (integer,null)
    The balance amount of the order.
    Example: 2099

  - `data.order.total_tax_amount` (integer,null)
    The total tax amount of the order.
    Example: 2099

  - `data.order.total_discount_amount` (integer,null)
    The total discount amount of the order.
    Example: 2099

  - `data.order.payments` (array)
    The list of payments applied to the order.

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500