# Aryeo

# Introduction
The Aryeo API provides access to the Aryeo platform.

Version: 1.0.0
License: Apache 2.0

## Servers

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

## Security

### Token

[object Object]

Type: http
Scheme: bearer

## Download OpenAPI description

 - [Aryeo](https://docs.aryeo.com/_bundle/api/aryeo.yaml)

## Addresses

 - [POST /addresses](https://docs.aryeo.com/api/aryeo/addresses/post-addresses.md): Create address.
 - [GET /addresses/{address}](https://docs.aryeo.com/api/aryeo/addresses/addresses-address-get.md): Get address.
 - [PATCH /addresses/{address}](https://docs.aryeo.com/api/aryeo/addresses/addresses-address-patch.md): Update address.
## Appointments

 - [GET /appointments](https://docs.aryeo.com/api/aryeo/appointments/get-appointments.md): List appointments. By default, returns a list of appointments that have been scheduled and have not been canceled
 - [GET /appointments/{appointment_id}](https://docs.aryeo.com/api/aryeo/appointments/get-appointments-id.md): Get appointment.
 - [PUT /appointments/{appointment_id}](https://docs.aryeo.com/api/aryeo/appointments/put-appointments-appointment_id.md): Update appointment.
 - [PUT /appointments/{appointment_id}/cancel](https://docs.aryeo.com/api/aryeo/appointments/put-appointments-appointment-id-cancel.md): Cancel appointment. The appointments order's customer can be optionally notified of this change.
 - [PUT /appointments/{appointment_id}/postpone](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-postpone-put.md): Postpone appointment.
 - [PUT /appointments/{appointment_id}/reschedule](https://docs.aryeo.com/api/aryeo/appointments/put-appointments-appointment-id-reschedule.md): Reschedule appointment. The appointments order's customer can be optionally notified of this change.
 - [PUT /appointments/{appointment_id}/accept](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-accept-put.md): Accept appointment.
 - [PUT /appointments/{appointment_id}/decline](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-decline-put.md): Decline appointment.
 - [PUT /appointments/{appointment_id}/schedule](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-schedule-put.md): Schedule appointment.
 - [GET /appointments/{appointment_id}/availability](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-availability-get.md): Check appointment availability.
 - [GET /appointments/{appointment_id}/3dh-tour-link](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-3dh-tour-link-get.md): Get appointment 3D Home Capture link.
 - [PUT /appointments/{appointment_id}/items](https://docs.aryeo.com/api/aryeo/appointments/appointments-appointment-id-items-put.md): Sync the items attached to an appointment.
 - [POST /appointments/store](https://docs.aryeo.com/api/aryeo/appointments/appointments-store-post.md): Create appointment.
 - [POST /appointments/store-draft](https://docs.aryeo.com/api/aryeo/appointments/appointments-store-draft-post.md): Create a draft appointment.
 - [POST /appointments/store-drafts](https://docs.aryeo.com/api/aryeo/appointments/appointments-store-drafts-post.md): Create multiple draft appointments.
 - [PUT /appointments/{appointment_id}/draft](https://docs.aryeo.com/api/aryeo/appointments/put-appointments-appointment_id-draft.md): Update a draft appointment.
 - [DELETE /appointments/{appointment_id}/draft](https://docs.aryeo.com/api/aryeo/appointments/delete-appointments-appointment_id-draft.md): Delete a draft appointment.
## Company Users

 - [GET /company-team-members](https://docs.aryeo.com/api/aryeo/company-users/company-team-members-get.md): List company team members.
 - [GET /company-team-members/{company_team_member_id}](https://docs.aryeo.com/api/aryeo/company-users/company-team-members-company-team-member-id-get.md): Get company team member.
 - [GET /company-team-members/{company_team_member_id}/events](https://docs.aryeo.com/api/aryeo/company-users/company-team-members-company-team-member-id-events-get.md): List company team member events.
## Customer Users

 - [GET /customer-team-members/{customer_team_member_id}](https://docs.aryeo.com/api/aryeo/customer-users/customer-team-members-customer-team-member-id-get.md): Get customer team member.
 - [GET /customer-teams/{customer_team_id}/memberships](https://docs.aryeo.com/api/aryeo/customer-users/customer-teams-customer-team-id-memberships-get.md): List customer team memberships.
 - [POST /customer-teams/affiliate-memberships](https://docs.aryeo.com/api/aryeo/customer-users/customer-teams-affiliate-memberships-post.md): Create customer team affiliate membership.
 - [GET /customer-users](https://docs.aryeo.com/api/aryeo/customer-users/customer-users-get.md): List customer users.
 - [POST /customer-users](https://docs.aryeo.com/api/aryeo/customer-users/customer-users-post.md): Create customer user.
 - [POST /customer-users/{user}/credit-transactions](https://docs.aryeo.com/api/aryeo/customer-users/customer-users-user-credit-transactions-store-post.md): Store customer user credit transaction.
 - [GET /customers](https://docs.aryeo.com/api/aryeo/customer-users/customers-get.md): List customers.
 - [POST /customers](https://docs.aryeo.com/api/aryeo/customer-users/customers-post.md): Create a customer.
## Discounts

 - [GET /coupons](https://docs.aryeo.com/api/aryeo/discounts/get-coupons.md): List coupons.
 - [POST /discounts](https://docs.aryeo.com/api/aryeo/discounts/post-discounts.md): Create discount.
 - [DELETE /discounts/{discount_id}](https://docs.aryeo.com/api/aryeo/discounts/delete-discounts-discount-id.md): Delete discount.
 - [DELETE /orders/{order}/discounts/{discount}](https://docs.aryeo.com/api/aryeo/discounts/orders-order-discounts-discount-delete.md): Delete order discount.
 - [POST /promotion-codes/redeem/{discountedType}/{discounted}](https://docs.aryeo.com/api/aryeo/discounts/promotion-codes-redeem-discountedtype-discounted-post.md): Redeem promotion code.
 - [POST /refunds/{orderPayment}](https://docs.aryeo.com/api/aryeo/discounts/refunds-orderpayment-post.md): Refund order payment.
## Listings

 - [GET /listings](https://docs.aryeo.com/api/aryeo/listings/get-listings.md): Lists all listings available to a group.
 - [POST /listings](https://docs.aryeo.com/api/aryeo/listings/post-listings.md): Create listing.
 - [GET /listings/{listing_id}](https://docs.aryeo.com/api/aryeo/listings/get-listings-id.md): Get listing.
 - [PUT /listings/{listing_id}](https://docs.aryeo.com/api/aryeo/listings/update-listings.md): Update listing.
 - [GET /listings/{listing_id}/cubi-casa](https://docs.aryeo.com/api/aryeo/listings/listings-listing-id-cubi-casa-get.md): Get listing Cubicasa information.
 - [GET /listings/{listing_id}/details/search](https://docs.aryeo.com/api/aryeo/listings/listings-listing-id-details-search-get.md): Search listing details.
 - [GET /listings/{listing_id}/stats](https://docs.aryeo.com/api/aryeo/listings/listings-listing-id-stats-get.md): Get listing statistics.
## Notes

 - [PUT /orders/{order_id}/notes](https://docs.aryeo.com/api/aryeo/notes/orders-order-id-notes-put.md): Update order notes.
## Order Forms

 - [POST /order-form-sessions](https://docs.aryeo.com/api/aryeo/order-forms/post-order-form-sessions.md): Create order form session
 - [GET /order-forms](https://docs.aryeo.com/api/aryeo/order-forms/get-order-forms.md): Lists all order forms for the current group.
## Order Items

 - [POST /order-items](https://docs.aryeo.com/api/aryeo/order-items/post-order-items.md): Create order item.
 - [GET /order-items/{order_item_id}](https://docs.aryeo.com/api/aryeo/order-items/get-order-items-order-item-id.md): Get order item.
 - [PUT /order-items/{order_item_id}](https://docs.aryeo.com/api/aryeo/order-items/put-order-items-order-item-id.md): Update order item.
 - [DELETE /order-items/{order_item_id}](https://docs.aryeo.com/api/aryeo/order-items/delete-order-items-order-item-id.md): Delete order item.
## Orders

 - [GET /orders](https://docs.aryeo.com/api/aryeo/orders/get-orders.md): Lists all orders of a group.
 - [POST /orders](https://docs.aryeo.com/api/aryeo/orders/post-orders.md): Create order.
 - [GET /orders/{order_id}](https://docs.aryeo.com/api/aryeo/orders/get-orders-id.md): Get order.
 - [POST /orders/{order}/payments](https://docs.aryeo.com/api/aryeo/orders/orders-order-payments-post.md): Create a manual order payment.
 - [PUT /orders/{order}/billing-address](https://docs.aryeo.com/api/aryeo/orders/orders-order-billing-address-put.md): Update order billing address.
 - [GET /orders/{order}/payment-info](https://docs.aryeo.com/api/aryeo/orders/orders-order-payment-info-get.md): Get payment information an order.
## Payroll

 - [POST /billing/setup-intents](https://docs.aryeo.com/api/aryeo/payroll/billing-setup-intents-post.md): Create billing setup intent.
 - [GET /order-items/{order_item_id}/pay-run-item-defaults](https://docs.aryeo.com/api/aryeo/payroll/order-items-order-item-id-pay-run-item-defaults-get.md): List order item pay run item defaults.
## Products

 - [GET /products](https://docs.aryeo.com/api/aryeo/products/get-products.md): List products.
 - [GET /product-categories](https://docs.aryeo.com/api/aryeo/products/get-product-categories.md): List product categories.
 - [POST /taxes](https://docs.aryeo.com/api/aryeo/products/post-taxes.md): Create tax.
 - [DELETE /taxes/{tax_id}](https://docs.aryeo.com/api/aryeo/products/delete-taxes-tax-id.md): Delete tax.
 - [GET /territories](https://docs.aryeo.com/api/aryeo/products/get-territories.md): List territories.
## Scheduling

 - [POST /blocks](https://docs.aryeo.com/api/aryeo/scheduling/blocks-post.md): Create block.
 - [DELETE /blocks/{block_id}](https://docs.aryeo.com/api/aryeo/scheduling/blocks-block-id-delete.md): Delete block.
 - [GET /blocks/{block_id}](https://docs.aryeo.com/api/aryeo/scheduling/blocks-block-id-get.md): Get block.
 - [PUT /blocks/{block_id}](https://docs.aryeo.com/api/aryeo/scheduling/blocks-block-id-put.md): Update block.
 - [GET /regions](https://docs.aryeo.com/api/aryeo/scheduling/regions-get.md): List regions.
 - [GET /scheduling/assignment](https://docs.aryeo.com/api/aryeo/scheduling/scheduling-assignment-get.md): Get scheduling assignment.
 - [GET /scheduling/available-dates](https://docs.aryeo.com/api/aryeo/scheduling/get-available-dates.md): List available dates. Availability can be listed using a specific start & end date range, or using a timeframe. When using a timeframe, the page parameter can be used to flip through weeks, months, et
 - [GET /scheduling/available-timeslots](https://docs.aryeo.com/api/aryeo/scheduling/get-available-timeslots.md): List available timeslots. Timeslots are returned for the entire day in the local timezone. Results are returned in UTC!
 - [GET /scheduling/item-groupings](https://docs.aryeo.com/api/aryeo/scheduling/scheduling-item-groupings-get.md): List schedule item groupings.
## Tags

 - [POST /customer-teams/{customer_team_id}/tags](https://docs.aryeo.com/api/aryeo/tags/customer-teams-customer-team-id-tags-post.md): Create customer team tag.
 - [PUT /customer-teams/{customer_team_id}/tags](https://docs.aryeo.com/api/aryeo/tags/customer-teams-customer-team-id-tags-put.md): Update customer team tag.
 - [DELETE /customer-teams/{customer_team_id}/tags/{tag_id}](https://docs.aryeo.com/api/aryeo/tags/customer-teams-customer-team-id-tags-tag-id-delete.md): Delete customer team tag.
 - [POST /orders/{order_id}/tags](https://docs.aryeo.com/api/aryeo/tags/orders-order-id-tags-post.md): Create tag for order.
 - [PUT /orders/{order_id}/tags](https://docs.aryeo.com/api/aryeo/tags/put-order-tags-tag-id.md): Update tag for order.
 - [DELETE /orders/{order_id}/tags/{tag_id}](https://docs.aryeo.com/api/aryeo/tags/orders-order-id-tags-tag-id-delete.md): Delete tag for order.
 - [POST /products/{product_id}/tags](https://docs.aryeo.com/api/aryeo/tags/post-products-product-id-tags.md): Create tag.
 - [PUT /products/{product_id}/tags](https://docs.aryeo.com/api/aryeo/tags/put-products-product-id-tags.md): Update product tag.
 - [PUT /products/{product_id}/tags/{tag_id}](https://docs.aryeo.com/api/aryeo/tags/put-products-product-id-tags-tag-id.md): Update tag.
 - [DELETE /products/{product_id}/tags/{tag_id}](https://docs.aryeo.com/api/aryeo/tags/delete-products-product-id-tags-tag-id.md): Delete product tag.
 - [POST /tags](https://docs.aryeo.com/api/aryeo/tags/tags-post.md): Create tag.
 - [PUT /tags/{tag_id}](https://docs.aryeo.com/api/aryeo/tags/tags-tag-id-put.md): Update tag.
## Tasks

 - [GET /tasks](https://docs.aryeo.com/api/aryeo/tasks/tasks-get.md): List tasks.
 - [POST /tasks](https://docs.aryeo.com/api/aryeo/tasks/tasks-post.md): Create task.
 - [DELETE /tasks/{task_id}](https://docs.aryeo.com/api/aryeo/tasks/tasks-task-id-delete.md): Delete task.
 - [GET /tasks/{task_id}](https://docs.aryeo.com/api/aryeo/tasks/tasks-task-id-get.md): Get task.
 - [PUT /tasks/{task_id}](https://docs.aryeo.com/api/aryeo/tasks/tasks-task-id-put.md): Update task.
 - [PUT /tasks/{task_id}/complete](https://docs.aryeo.com/api/aryeo/tasks/tasks-task-id-complete-put.md): Complete task.
 - [PUT /tasks/{task_id}/reinstate](https://docs.aryeo.com/api/aryeo/tasks/tasks-task-id-reinstate-put.md): Reinstate task.
## Videos

 - [GET /videos/{video_id}](https://docs.aryeo.com/api/aryeo/videos/get-videos-video-id.md): Get video.
 - [PUT /videos/{video_id}](https://docs.aryeo.com/api/aryeo/videos/put-videos-video-id.md): Update video.
 - [DELETE /videos/{video_id}](https://docs.aryeo.com/api/aryeo/videos/delete-videos-video-id.md): Delete video.