# Create order form session.

Create order form session

Endpoint: POST /order-form-sessions
Version: 1.0.0
Security: Token

## Request fields (application/json):

  - `order_form_id` (string, required)
    ID of an order form to associate with the order form session. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `address_id` (string)
    ID of an address to associate with the order form session. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `address_data` (object)
    Data used to generate a new Address object inline. If you create an address upfront, pass the address_id parameter. Otherwise, this address_data will be used to scaffold a new Address object, if present.

  - `address_data.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

  - `address_data.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

  - `address_data.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"

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

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

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

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

  - `address_data.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"

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

  - `address_data.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"

  - `address_data.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"

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

  - `address_data.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"

  - `customer_id` (string)
    ID of the customer to associate with the order form session. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `customer_group_id` (string)
    ID of the customer group to associate with the order form session. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `customer_data` (object)
    Data used to generate or retrieve a Customer object inline. If you create an customer upfront, pass the customer_id parameter. Otherwise, this customer_data will be used to scaffold a new Customer (Group) object, if present.

  - `customer_data.sso_id` (string)
    Single sign on identifier.
    Example: "auth0_1234567890"

  - `customer_data.sso_user_id` (string)
    Single sign on identifier of the customer user.
    Example: "auth0_1234567890"

  - `customer_data.email` (string)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `customer_data.first_name` (string,null)
    First name of the user.
    Example: "John"

  - `customer_data.last_name` (string,null)
    Last name of the user.
    Example: "Doe"

  - `customer_data.phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "(123) 456-7890"

  - `coupon_ids` (array)
    IDs of the coupons to associate with this order.
    Example: ["00000000-0000-4000-8000-000000000000"]

  - `step_visibility` (object)
    Settings for hidding or showing certain steps of the order form during the booking process. Note, steps can only be hidden if all required information is supplied in the OrderFormSession. By default, all steps are shown.

  - `step_visibility.show_address_step` (boolean)
    If the address step is hidden or shown during the booking process. Only applicable if address_id or address_data parameters are set.
    Example: true

  - `step_visibility.show_customer_step` (boolean)
    If the customer step is hidden or shown during the booking process. Only applicable if customer_id or customer_data parameters are set.
    Example: true

  - `success_url` (string)
    The URL the customer will be directed to after the payment or order placement is successful. By default, customers are directed to the Aryeo order confirmation page.
    Example: "https://my-company.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000/order-confirmation"

## Response 201 fields (application/json):

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

  - `data` (object)
    An order form session is used to pre-fill information about an order being placed via an order form. Through the session, you can also configure other display settings for an order form during that session.

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

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

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

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

  - `data.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_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_form.is_public` (boolean)
    Indicates if the order form is publicly visible to all customers on the order form page
    Example: true

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

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

  - `data.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_form.slot_interval_minutes` (integer)
    How frequently slotted available times are on the order form.
    Example: 60

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

  - `data.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_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_form.require_upfront_payment` (boolean)
    Indicates if the order form requires an upfront payment to place the order.
    Example: true

  - `data.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_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_form.form_settings` (object)
    The settings for the order form.

  - `data.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_form.owner.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_form.owner.name` (string, required)
    The name of the group.
    Example: "John Doe Reality"

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

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

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

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

  - `data.order_form.owner.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_form.owner.license_number` (string,null)
    The license number of a real estate agent. Only returned if group's type is AGENT.
    Example: "12345678"

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

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

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

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

  - `data.order_form.owner.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_form.owner.order_page_background_color` (string,null)
    The background color for the order page (has a hex value) for the group.
    Example: "#FF0000"

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

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

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

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

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

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

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

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

  - `data.order_form.owner.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_form.owner.slot_interval_minutes` (integer,null)
    How frequently slotted available times are on the order form by default.
    Example: 60

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

  - `data.order_form.owner.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_form.owner.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_form.owner.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_form.owner.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_form.owner.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_form.owner.owner` (object,null)
    A record of a person on the Aryeo platform.

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

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

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

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

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

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

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

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

  - `data.order_form.owner.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_form.owner.owner.sso_users` (array)
    The list of SSO users associated with this user.

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

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

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

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

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

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

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

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

  - `data.order_form.owner.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_form.owner.users` (array,null)
    The Aryeo users associated with this group.

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

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

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

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

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

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

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

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

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

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

  - `data.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.address` (object)
    A street address and additional metadata about a location.

  - `data.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.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.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.address.street_name` (string,null)
    The street name portion of a location's address.
    Example: "South St"

  - `data.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.address.postal_code` (string,null)
    The postal code portion of a location's address.
    Example: "02111"

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

  - `data.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.address.county_or_parish` (string,null)
    The County, Parish or other regional authority of the location.
    Example: "Suffolk County"

  - `data.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.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.address.country` (string,null)
    The ISO 3166-1 country code for this for the country of the location.
    Example: "US"

  - `data.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.address.timezone` (string,null)
    The assumed timezone the address is located in.
    Example: "America/New_York"

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

  - `data.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.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.address.is_map_dirty` (boolean,null)
    Does this address need to be geocoded?
    Example: true

  - `data.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.coupons` (array)
    Coupons that should be automatically applied during this order form session.

  - `data.coupons.name` (string)
    Name of the coupon displayed to customers on orders.
    Example: "VIP Customer Discount"

  - `data.coupons.is_active` (boolean)
    Indicates if the coupon is currently active.
    Example: true

  - `data.coupons.is_percent_off` (boolean)
    Indicates if the coupon is a percent off coupon.
    Example: true

  - `data.coupons.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.coupons.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.coupons.amount_off_formatted` (string)
    The amount off formatted as a string.
    Example: "$25.00"

  - `data.coupons.promotion_codes` (array)

  - `data.coupons.promotion_codes.code` (string, required)
    The customer-facing code. This code must be unique across all active promotion codes.
    Example: "SPRING_SALE"

  - `data.coupons.promotion_codes.times_redeemed` (integer)
    The number of times the coupon has been redeemed.
    Example: 10

  - `data.coupons.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.coupons.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.coupons.promotion_codes.max_redemptions` (integer,null)
    The maximum number of times the promotion code can be redeemed.
    Example: 10

  - `data.coupons.promotion_codes.max_redemptions_per_customer` (integer,null)
    The maximum number of times the promotion code can be redeemed per customer.
    Example: 10

  - `data.coupons.promotion_codes.first_time_only` (boolean,null)
    Indicates if the promotion code can only be redeemed once per customer.
    Example: true

  - `data.coupons.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.coupons.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.coupons.discountables` (array)

  - `data.coupons.discountables.object` (string)
    String representing the object’s type. Objects of the same type share the same schema.
    Example: "DISCOUNTABLE"

  - `data.coupons.discountables.discountable` (object)
    A discountable item.

  - `data.coupons.discountables.discountable.title` (string)
    The title of the item.
    Example: "House photos"

  - `data.coupons.discountables.discountable.description` (string)
    The description of the item.
    Example: "Capture photos of a house for sale."

  - `data.coupons.discountables.discountable.active` (boolean)
    The active status of an item.
    Example: true

  - `data.coupons.discountables.discountable.type` (string)
    The type of item.
    Example: "MAIN"

  - `data.coupons.discountables.discountable.is_twilight` (boolean)
    Whether the item is available during twilight hours.
    Example: true

  - `data.coupons.discountables.discountable.image_url` (string,null)
    A URL for an example property image.
    Example: "https://picsum.photos/400/200"

  - `data.coupons.discountables.discountable.is_serviceable` (boolean)
    Whether the item is serviceable.
    Example: true

  - `data.coupons.discountables.discountable.requires_separate_booking` (boolean)
    Whether the item requires a separate booking.
    Example: true

  - `data.coupons.discountables.discountable.always_display_addons` (boolean)
    Whether to always display addons for the item.
    Example: true

  - `data.coupons.discountables.discountable.variant_filter_type` (string,null)
    The type of variant filter.
    Example: "ALL"

  - `data.coupons.discountables.discountable.avalara_tax_code` (string,null)
    The Avalara tax code for the item.
    Example: "12345"

  - `data.coupons.discountables.discountable.limit_quantity_amount` (integer,null)
    The limit quantity amount for the item.
    Example: 10

  - `data.coupons.discountables.discountable.limit_quantity` (boolean)
    Whether the item has a limit quantity.
    Example: true

  - `data.coupons.discountables.discountable.is_filterable` (boolean)
    Whether the item is filterable.
    Example: true

  - `data.coupons.discountables.discountable.is_esoft_adjustment` (boolean)
    Whether the item is an eSoft adjustment.
    Example: true

  - `data.coupons.discountables.discountable.variants` (array)

  - `data.coupons.discountables.discountable.variants.title` (string, required)
    The title of the product variant.
    Example: "House photos"

  - `data.coupons.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.coupons.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.coupons.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.coupons.discountables.discountable.variants.base_is_hidden` (boolean)
    Indicates if the base price of the product variant is hidden.
    Example: true

  - `data.coupons.discountables.discountable.variants.display_original_price` (boolean)
    Indicates if the original price of the product variant should be displayed.
    Example: true

  - `data.coupons.discountables.discountable.variants.duration` (integer)
    The duration of the product item, in minutes.
    Example: 60

  - `data.coupons.discountables.discountable.categories` (array)

  - `data.coupons.discountables.discountable.categories.title` (string, required)
    The title of the product category.
    Example: "Photography"

  - `data.coupons.discountables.discountable.categories.name` (string)
    The name of the product category.
    Example: "Photography"

  - `data.coupons.discountables.discountable.categories.slug` (string)
    The slug of the product category.
    Example: "photography"

  - `data.coupons.discountables.discountable.categories.color` (string)
    The color of the product category.
    Example: "#000000"

  - `data.coupons.discountables.discountable.categories.type` (string)
    The type of the product category.
    Example: "product"

  - `data.coupons.discountables.discountable.quickbooks_item_id` (string,null)
    The Quickbooks item ID for the item.
    Example: "12345"

  - `data.coupons.discountables.discountable.amount` (number)
    The amount of the item.
    Example: 100

  - `data.coupons.discountables.discountable.name` (string)
    The name of the item.
    Example: "Flat Fee"

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

  - `data.show_header` (boolean)
    If the header of the order form is hidden or shown during the booking process.
    Example: true

  - `data.step_visibility` (object)
    Settings for hidding or showing certain steps of the order form during the booking process. Note, steps can only be hidden if all required information is supplied in the OrderFormSession.

  - `data.step_visibility.show_address_step` (boolean)
    If the address step is hidden or shown during the booking process. Only applicable if address_id or address_data parameters are set.
    Example: true

  - `data.step_visibility.show_customer_step` (boolean)
    If the customer step is hidden or shown during the booking process. Only applicable if customer_id or customer_data parameters are set.
    Example: true

  - `data.product_filters` (object)
    Product filters that should be automatically applied during this order form session.

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

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

  - `data.success_url` (string)
    The URL the customer will be directed to after the payment or order placement is successful. By default, customers are directed to the Aryeo order confirmation page.
    Example: "https://my-company.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000/order-confirmation"

  - `data.url` (string)
    The URL of the order form session. Redirect customers to this URL to take them to correct order form.
    Example: "https://my-company.aryeo.com/order-form-sessions/00000000-0000-4000-8000-000000000000"

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

## Response 403 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: 403

## 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