The Aryeo API provides access to the Aryeo platform.
https://docs.aryeo.com/_mock/api/aryeo/
https://api.aryeo.com/v1/
OrderPostPayload
ID of the order to associate this order item to. UUID Version 4.
ID of the product variant to create this order item from. UUID Version 4.
A positive integer representing the number of instances of this item that was or will be serviced.
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. Required when a product variant ID is not specified.
The title of the item. Required when a product variant ID is not specified.
The subtitle of the item. Required when a product variant ID is not specified.
The description of the item. Required when a product variant ID is not specified.
ID of the appointment that is scheduled to service this order item. UUID Version 4.
https://docs.aryeo.com/_mock/api/aryeo/order-items
https://api.aryeo.com/v1/order-items
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/order-items`,
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
},
body: JSON.stringify({
order_id: '00000000-0000-4000-8000-000000000000',
product_variant_id: '00000000-0000-4000-8000-000000000000',
quantity: 3,
unit_price_amount: 2099,
title: 'Aerial Video',
subtitle: '3000-3999 square feet',
description: 'A fly-by drone video of the property.',
appointment_id: '00000000-0000-4000-8000-000000000000',
assigned_company_team_member_id: '00000000-0000-4000-8000-000000000000'
})
}
);
const data = await resp.json();
console.log(data);{ "status": "success", "data": { "object": "ORDER_ITEM", "id": "00000000-0000-4000-8000-000000000000", "title": "Aerial Video", "subtitle": "10 minute video", "sub_title": "10 minute video", "description": "A fly-by drone video of the property.", "purchasable_type": "FEE", "amount": 2099, "unit_price_amount": 2099, "quantity": 2, "gross_total_amount": 4198, "appointment": { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { … } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { … }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { … }, "building": { … }, "price": { … }, "list_agent": { … }, "co_list_agent": { … }, "customer_team_memberships": [ … ], "images": [ … ], "videos": [ … ], "floor_plans": [ … ], "interactive_content": [ … ], "property_website": { … }, "marketing_materials": [ … ], "orders": [ … ], "appointments": [ … ], "unconfirmed_appointments": [ … ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { … }, "company": { … } }, "discounts": [ { … } ], "tags": [ { … } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ {} ], "unconfirmed_appointments": [ {} ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { … } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { … } ] }, "users": [ { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true } ], "items": [ {} ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ {} ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ { "object": "COMPANY_TEAM_MEMBER", "id": "00000000-0000-4000-8000-000000000000", "calendar_color": "#FF0000", "permissions": [ … ], "restrictions": [ … ], "is_service_provider": true, "external_id": "1234567890", "company_user": { … } } ], "appointment_attendances": [ { "object": "APPOINTMENT_ATTENDANCE", "id": 1234567890, "company_team_member": { … }, "zillow_3d_home_deep_link_url": "https://aryeo.com", "is_requested": true, "accepted_at": "2021-06-30T20:30:00Z", "declined_at": "2021-06-30T20:30:00Z" } ] }, "discounts": [ { "object": "APP\\DISCOUNTS\\MODELS\\DISCOUNTAMOUNT", "id": "00000000-0000-4000-8000-000000000000", "discount": { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } }, "amount": 2999, "applied_percent_off": 0.2, "applied_amount_off": 2500, "created_at": "2021-06-30T20:30:00Z" } ], "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ "require_photographer_confirmations" ], "order_page_background_color": "#FF0000", "social_profiles": { "facebook_profile_url": "https://www.facebook.com/johndoe", "instagram_profile_url": "https://www.instagram.com/johndoe", "twitter_profile_url": "https://twitter.com/johndoe", "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/", "zillow_profile_url": "https://www.zillow.com/profile/johndoe" }, "default_order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": {}, "company": {} }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ { … } ], "owner": { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true }, "users": [ { … } ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ { … } ], "customer_group": "null", "custom_field_entries": [ {} ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { "size_acres": 0.47, "open_parking_spaces": 3 }, "building": { "bedrooms": 4, "bathrooms": 3.5, "square_feet": 2511, "year_built": 1960, "bedrooms_number": 4 }, "price": { "list_price": 250000, "list_price_formatted": "$250,000" }, "list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "co_list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_team_memberships": [ { … } ], "images": [ { … } ], "videos": [ { … } ], "floor_plans": [ { … } ], "interactive_content": [ { … } ], "property_website": { "id": "00000000-0000-4000-8000-000000000000", "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded", "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded" }, "marketing_materials": [ { … } ], "orders": [ {} ], "appointments": [ { … } ], "unconfirmed_appointments": [ { … } ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "company": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "discounts": [ { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } } ], "tags": [ { "object": "APP\\TAGS\\MODELS\\TAG", "id": "00000000-0000-4000-8000-000000000000", "name": "Photography", "slug": "photography", "color": "#8BC34A", "font_color": "#FFFFFF" } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "unconfirmed_appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { … } } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { "object": "ORDER_PAYMENT", "id": "00000000-0000-4000-8000-000000000000", "type": "MANUAL", "collection_source": "CASH", "completed_at": "2021-06-30T20:30:00Z", "applicable_amount": 502, "tip_amount": 100, "total_amount": 502, "collected_amount": 502, "order": {} } ] }, "product": { "object": "PRODUCT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "description": "Capture photos of a house for sale.", "active": true, "type": "MAIN", "is_twilight": true, "image_url": "https://picsum.photos/400/200", "is_serviceable": true, "requires_separate_booking": true, "always_display_addons": true, "variant_filter_type": "ALL", "avalara_tax_code": "12345", "limit_quantity_amount": 10, "limit_quantity": true, "is_filterable": true, "is_esoft_adjustment": true, "variants": [ { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 } ], "categories": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ], "tags": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ] }, "product_variant": { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 }, "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { "object": "TAX_RATE", "id": "00000000-0000-4000-8000-000000000000", "name": "New York State Tax", "description": "Tax rate applied for any property that falls within the bounds New York State.", "applied_rate": 0.075, "rate": "0.075000", "is_active": true, "is_inclusive": true } } ], "is_serviceable": true, "tasks": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "Complete 41 Drone Shots, Variant corporis", "description": "Complete 41 Drone Shots, Variant corporis", "quantity": 1, "pay_run_item_amount": 10000, "due_at": "2021-06-30T20:30:00Z", "completed_at": "2021-06-30T20:30:00Z", "is_completed": true } ], "is_canceled": true }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/order-items/{order_item_id}
https://api.aryeo.com/v1/order-items/{order_item_id}
const orderItemId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/order-items/${orderItemId}`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": { "object": "ORDER_ITEM", "id": "00000000-0000-4000-8000-000000000000", "title": "Aerial Video", "subtitle": "10 minute video", "sub_title": "10 minute video", "description": "A fly-by drone video of the property.", "purchasable_type": "FEE", "amount": 2099, "unit_price_amount": 2099, "quantity": 2, "gross_total_amount": 4198, "appointment": { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { … } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { … }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { … }, "building": { … }, "price": { … }, "list_agent": { … }, "co_list_agent": { … }, "customer_team_memberships": [ … ], "images": [ … ], "videos": [ … ], "floor_plans": [ … ], "interactive_content": [ … ], "property_website": { … }, "marketing_materials": [ … ], "orders": [ … ], "appointments": [ … ], "unconfirmed_appointments": [ … ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { … }, "company": { … } }, "discounts": [ { … } ], "tags": [ { … } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ {} ], "unconfirmed_appointments": [ {} ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { … } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { … } ] }, "users": [ { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true } ], "items": [ {} ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ {} ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ { "object": "COMPANY_TEAM_MEMBER", "id": "00000000-0000-4000-8000-000000000000", "calendar_color": "#FF0000", "permissions": [ … ], "restrictions": [ … ], "is_service_provider": true, "external_id": "1234567890", "company_user": { … } } ], "appointment_attendances": [ { "object": "APPOINTMENT_ATTENDANCE", "id": 1234567890, "company_team_member": { … }, "zillow_3d_home_deep_link_url": "https://aryeo.com", "is_requested": true, "accepted_at": "2021-06-30T20:30:00Z", "declined_at": "2021-06-30T20:30:00Z" } ] }, "discounts": [ { "object": "APP\\DISCOUNTS\\MODELS\\DISCOUNTAMOUNT", "id": "00000000-0000-4000-8000-000000000000", "discount": { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } }, "amount": 2999, "applied_percent_off": 0.2, "applied_amount_off": 2500, "created_at": "2021-06-30T20:30:00Z" } ], "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ "require_photographer_confirmations" ], "order_page_background_color": "#FF0000", "social_profiles": { "facebook_profile_url": "https://www.facebook.com/johndoe", "instagram_profile_url": "https://www.instagram.com/johndoe", "twitter_profile_url": "https://twitter.com/johndoe", "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/", "zillow_profile_url": "https://www.zillow.com/profile/johndoe" }, "default_order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": {}, "company": {} }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ { … } ], "owner": { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true }, "users": [ { … } ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ { … } ], "customer_group": "null", "custom_field_entries": [ {} ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { "size_acres": 0.47, "open_parking_spaces": 3 }, "building": { "bedrooms": 4, "bathrooms": 3.5, "square_feet": 2511, "year_built": 1960, "bedrooms_number": 4 }, "price": { "list_price": 250000, "list_price_formatted": "$250,000" }, "list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "co_list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_team_memberships": [ { … } ], "images": [ { … } ], "videos": [ { … } ], "floor_plans": [ { … } ], "interactive_content": [ { … } ], "property_website": { "id": "00000000-0000-4000-8000-000000000000", "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded", "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded" }, "marketing_materials": [ { … } ], "orders": [ {} ], "appointments": [ { … } ], "unconfirmed_appointments": [ { … } ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "company": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "discounts": [ { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } } ], "tags": [ { "object": "APP\\TAGS\\MODELS\\TAG", "id": "00000000-0000-4000-8000-000000000000", "name": "Photography", "slug": "photography", "color": "#8BC34A", "font_color": "#FFFFFF" } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "unconfirmed_appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { … } } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { "object": "ORDER_PAYMENT", "id": "00000000-0000-4000-8000-000000000000", "type": "MANUAL", "collection_source": "CASH", "completed_at": "2021-06-30T20:30:00Z", "applicable_amount": 502, "tip_amount": 100, "total_amount": 502, "collected_amount": 502, "order": {} } ] }, "product": { "object": "PRODUCT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "description": "Capture photos of a house for sale.", "active": true, "type": "MAIN", "is_twilight": true, "image_url": "https://picsum.photos/400/200", "is_serviceable": true, "requires_separate_booking": true, "always_display_addons": true, "variant_filter_type": "ALL", "avalara_tax_code": "12345", "limit_quantity_amount": 10, "limit_quantity": true, "is_filterable": true, "is_esoft_adjustment": true, "variants": [ { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 } ], "categories": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ], "tags": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ] }, "product_variant": { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 }, "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { "object": "TAX_RATE", "id": "00000000-0000-4000-8000-000000000000", "name": "New York State Tax", "description": "Tax rate applied for any property that falls within the bounds New York State.", "applied_rate": 0.075, "rate": "0.075000", "is_active": true, "is_inclusive": true } } ], "is_serviceable": true, "tasks": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "Complete 41 Drone Shots, Variant corporis", "description": "Complete 41 Drone Shots, Variant corporis", "quantity": 1, "pay_run_item_amount": 10000, "due_at": "2021-06-30T20:30:00Z", "completed_at": "2021-06-30T20:30:00Z", "is_completed": true } ], "is_canceled": true }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/order-items/{order_item_id}
https://api.aryeo.com/v1/order-items/{order_item_id}
const orderItemId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/order-items/${orderItemId}`,
{
method: 'PUT',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": { "object": "ORDER_ITEM", "id": "00000000-0000-4000-8000-000000000000", "title": "Aerial Video", "subtitle": "10 minute video", "sub_title": "10 minute video", "description": "A fly-by drone video of the property.", "purchasable_type": "FEE", "amount": 2099, "unit_price_amount": 2099, "quantity": 2, "gross_total_amount": 4198, "appointment": { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { … } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { … }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { … }, "building": { … }, "price": { … }, "list_agent": { … }, "co_list_agent": { … }, "customer_team_memberships": [ … ], "images": [ … ], "videos": [ … ], "floor_plans": [ … ], "interactive_content": [ … ], "property_website": { … }, "marketing_materials": [ … ], "orders": [ … ], "appointments": [ … ], "unconfirmed_appointments": [ … ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { … }, "company": { … } }, "discounts": [ { … } ], "tags": [ { … } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ {} ], "unconfirmed_appointments": [ {} ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { … } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { … } ] }, "users": [ { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true } ], "items": [ {} ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ {} ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ { "object": "COMPANY_TEAM_MEMBER", "id": "00000000-0000-4000-8000-000000000000", "calendar_color": "#FF0000", "permissions": [ … ], "restrictions": [ … ], "is_service_provider": true, "external_id": "1234567890", "company_user": { … } } ], "appointment_attendances": [ { "object": "APPOINTMENT_ATTENDANCE", "id": 1234567890, "company_team_member": { … }, "zillow_3d_home_deep_link_url": "https://aryeo.com", "is_requested": true, "accepted_at": "2021-06-30T20:30:00Z", "declined_at": "2021-06-30T20:30:00Z" } ] }, "discounts": [ { "object": "APP\\DISCOUNTS\\MODELS\\DISCOUNTAMOUNT", "id": "00000000-0000-4000-8000-000000000000", "discount": { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } }, "amount": 2999, "applied_percent_off": 0.2, "applied_amount_off": 2500, "created_at": "2021-06-30T20:30:00Z" } ], "order": { "object": "ORDER", "id": "00000000-0000-4000-8000-000000000000", "identifier": "Order #2", "number": 100, "title": "Order #100", "status": "GHOST", "order_status": "OPEN", "is_ghost": true, "fulfilled_at": "2021-06-30T20:30:00Z", "fulfillment_status": "FULFILLED", "payment_status": "PAID", "internal_notes": "Hey there notes!", "currency": "USD", "total_amount": 2099, "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order", "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status", "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download", "downloads_allowed": true, "payments_allowed": true, "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ "require_photographer_confirmations" ], "order_page_background_color": "#FF0000", "social_profiles": { "facebook_profile_url": "https://www.facebook.com/johndoe", "instagram_profile_url": "https://www.instagram.com/johndoe", "twitter_profile_url": "https://twitter.com/johndoe", "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/", "zillow_profile_url": "https://www.zillow.com/profile/johndoe" }, "default_order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": {}, "company": {} }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ { … } ], "owner": { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true }, "users": [ { … } ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ { … } ], "customer_group": "null", "custom_field_entries": [ {} ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_group": { "id": "00000000-0000-4000-8000-000000000000", "name": "John Doe Customer Group", "affiliate_id": "JOHN_DOE", "billing_customer": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "listing": { "object": "LISTING", "id": "00000000-0000-4000-8000-000000000000", "address": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "mls_number": "1850209", "type": "RESIDENTIAL", "sub_type": "SINGLE_FAMILY_RESIDENCE", "status": "COMING_SOON", "standard_status": "COMING_SOON", "thumbnail_url": "https://picsum.photos/640/480", "large_thumbnail_url": "https://picsum.photos/1280/960", "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.", "lot": { "size_acres": 0.47, "open_parking_spaces": 3 }, "building": { "bedrooms": 4, "bathrooms": 3.5, "square_feet": 2511, "year_built": 1960, "bedrooms_number": 4 }, "price": { "list_price": 250000, "list_price_formatted": "$250,000" }, "list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "co_list_agent": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": { … }, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "customer_team_memberships": [ { … } ], "images": [ { … } ], "videos": [ { … } ], "floor_plans": [ { … } ], "interactive_content": [ { … } ], "property_website": { "id": "00000000-0000-4000-8000-000000000000", "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded", "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded" }, "marketing_materials": [ { … } ], "orders": [ {} ], "appointments": [ { … } ], "unconfirmed_appointments": [ { … } ], "downloads_enabled": true, "is_showcase": true, "is_showcasable": true, "has_high_resolution_images": true, "has_zillow_imx_tour": true, "delivery_status": "DELIVERED" }, "order_form": { "object": "ORDER_FORM", "id": "00000000-0000-4000-8000-000000000000", "title": "BQ's Photography Order Form", "type": "ARYEO", "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000", "is_public": true, "thumbnail_url": "https://picsum.photos/300", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "require_upfront_payment": true, "upfront_payment_percentage": 50, "use_instant_appointment_scheduling": true, "form_settings": "{}", "owner": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 }, "company": { "object": "GROUP", "id": "00000000-0000-4000-8000-000000000000", "type": "AGENT", "name": "John Doe Reality", "email": "john.doe@gmail.com", "phone": "6175550173", "website_url": "https://www.aryeo.com", "logo_url": "https://picsum.photos/300", "office_name": "John Doe Brokerage", "license_number": "12345678", "timezone": "America/New_York", "currency": "USD", "slug": "example-photography", "order_page_url": "https://example-photography.aryeo.com/order", "feature_flags": [ … ], "order_page_background_color": "#FF0000", "social_profiles": { … }, "default_order_form": {}, "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "allow_order_cancellation": true, "order_forms": [ … ], "owner": { … }, "users": [ … ], "is_brokerage_or_brokerage_agent": true, "avatar_url": "https://picsum.photos/300", "internal_notes": "Internal notes about the group.", "team_members": [ … ], "customer_group": "null", "custom_field_entries": [ … ], "created_at": "2021-06-30T20:30:00Z", "has_restricted_photographers": true, "is_visible": true, "order_index": 1 } }, "discounts": [ { "object": "DISCOUNT", "id": "00000000-0000-4000-8000-000000000000", "total_discount_amount": 1000, "coupon": { … } } ], "tags": [ { "object": "APP\\TAGS\\MODELS\\TAG", "id": "00000000-0000-4000-8000-000000000000", "name": "Photography", "slug": "photography", "color": "#8BC34A", "font_color": "#FFFFFF" } ], "items": [ {} ], "custom_items": [ {} ], "appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "unconfirmed_appointments": [ { "id": "00000000-0000-4000-8000-000000000000", "status": "SCHEDULED", "title": "Appointment title", "description": "Customer: John Doe\nOrder Details: Order #123", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T20:30:00Z", "rescheduled_at": "2021-06-30T20:30:00Z", "postponed_at": "2021-06-30T20:30:00Z", "previous_start_at": "2021-06-30T20:30:00Z", "preference_type": "TIME", "preferred_start_at": "2021-06-30T20:30:00Z", "preferred_start_at_day": "2021-06-30", "preferred_start_at_time_of_day": "AFTERNOON", "duration": 60, "user_has_appointments_manage_permission": true, "order": {}, "users": [ … ], "items": [ … ], "can_cancel": true, "can_reschedule": true, "is_within_cancellation_lock_period": true, "is_within_rescheduling_lock_period": true, "deleted_at": "2021-06-30T20:30:00Z", "requires_confirmation": true, "late_cancellation_fee": [ … ], "updated_at": "2021-06-30T20:30:00Z", "company_team_members": [ … ], "appointment_attendances": [ … ] } ], "created_at": "2021-06-30T20:30:00Z", "updated_at": "2021-06-30T20:30:00Z", "custom_fields": [ {} ], "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { … } } ], "booking_limits": { "object": "COMPANY", "use_territory_awareness": true, "availability_style": "TIME", "slot_interval_minutes": 60, "use_automated_user_assignment": true, "automated_user_assignment_strategy": "RECOMMENDED", "show_user_names": true, "use_instant_appointment_scheduling": true, "is_twilight_visible": true }, "filter_by_square_feet": true, "filter_by_list_price": true, "scheduling_assignment_strategy": "RECOMMENDED", "balance_amount": 2099, "total_tax_amount": 2099, "total_discount_amount": 2099, "payments": [ { "object": "ORDER_PAYMENT", "id": "00000000-0000-4000-8000-000000000000", "type": "MANUAL", "collection_source": "CASH", "completed_at": "2021-06-30T20:30:00Z", "applicable_amount": 502, "tip_amount": 100, "total_amount": 502, "collected_amount": 502, "order": {} } ] }, "product": { "object": "PRODUCT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "description": "Capture photos of a house for sale.", "active": true, "type": "MAIN", "is_twilight": true, "image_url": "https://picsum.photos/400/200", "is_serviceable": true, "requires_separate_booking": true, "always_display_addons": true, "variant_filter_type": "ALL", "avalara_tax_code": "12345", "limit_quantity_amount": 10, "limit_quantity": true, "is_filterable": true, "is_esoft_adjustment": true, "variants": [ { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 } ], "categories": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ], "tags": [ { "object": "PRODUCT_CATEGORY", "id": "00000000-0000-4000-8000-000000000000", "title": "Photography", "name": "Photography", "slug": "photography", "color": "#000000", "type": "product" } ] }, "product_variant": { "object": "PRODUCT_VARIANT", "id": "00000000-0000-4000-8000-000000000000", "title": "House photos", "price": 10000, "price_amount": 10000, "base_price_amount": 10000, "base_is_hidden": true, "display_original_price": true, "duration": 60 }, "taxes": [ { "object": "TAX", "id": "00000000-0000-4000-8000-000000000000", "total_tax_amount": 2099, "applied_rate": 0.075, "tax_rate": { "object": "TAX_RATE", "id": "00000000-0000-4000-8000-000000000000", "name": "New York State Tax", "description": "Tax rate applied for any property that falls within the bounds New York State.", "applied_rate": 0.075, "rate": "0.075000", "is_active": true, "is_inclusive": true } } ], "is_serviceable": true, "tasks": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "Complete 41 Drone Shots, Variant corporis", "description": "Complete 41 Drone Shots, Variant corporis", "quantity": 1, "pay_run_item_amount": 10000, "due_at": "2021-06-30T20:30:00Z", "completed_at": "2021-06-30T20:30:00Z", "is_completed": true } ], "is_canceled": true }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/order-items/{order_item_id}
https://api.aryeo.com/v1/order-items/{order_item_id}
const orderItemId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/order-items/${orderItemId}`,
{
method: 'DELETE',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
if (resp.status === 204) {
console.log('success');
} else {
const data = await resp.text();
console.log(data);
}