openapi: 3.0.3 info: title: ClickFunnels API description: > # Introduction The ClickFunnels v2 API lets you: - import data from other apps and sources into ClickFunnels and export data that you need somewhere else - extend the ClickFunnels platform to your own needs and embed it in your own applications - act on behalf of other ClickFunnels users via OAuth to offer extended services to other fellow ClickFunnels entrepreneurs We are starting with exposing a given set of resources but the goal is to converge in terms of functionality with what the actual app is offering and also offering functionality on top. For any feedback, please drop us a line at: - https://feedback.myclickfunnels.com/feature-requests?category=api For issues and support you can currently go here: - https://help.clickfunnels.com/hc/en-us # Authentication Making your first request is easiest with a Bearer token: ```shell $ curl 'https://myteam.myclickfunnels.com/api/v2/teams' \ --header 'Authorization: Bearer AVJrj0ZMJ-xoraUk1xxVM6UuL9KXmsWmnJvvSosUO6X' [{"id":3,"name":"My Team", # ... more output...}] ``` How to get your API key step by step: https://developers.myclickfunnels.com/docs/getting-started # Rate limiting The rate limit is currently set per IP address. The actual rate limit and the approach on how this is handled is subject to change in future releases. Please let us know if you have special request limit needs. # Pagination and Ordering In order to paginate through a large list response, you can use our cursor-based pagination using the `id` field of a given object in the list. There is a limit of 20 objects per list response ordered ascending by ID. So, you can get to items after the last one in the list, by taking the last item's ID and submitting it in a list request as the value of an `after` URL parameter. For example: ```shell # The first 20 contacts are returned without any pagination nor ordering params: $ curl 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts' --header 'Authorization: Bearer ...' [{"id": 1, "email_address": "first@contact.com" ...}, {"id": 4, ...} ... {"id": 55, "email_address": "last@contact.com", ...}] $ curl 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?after=55' --header 'Authorization: Bearer ...' [{"id": 56, ...}] # There is one more record after ID 55. ``` The `after` param always acts as if you are "turning the next page". So if you order in a descending order, you will also use `after` to get to the next records: ```shell $ curl 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?sort_order=desc' --header 'Authorization: Bearer ...' [{"id": 56, ...}, {"id": 55, ...}, {"id": 4, ...}] # All contacts in descending order. $ curl 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?sort_order=desc&after=4' --header 'Authorization: Bearer ...' [{"id": 1, ...}] # There is one more contact on the next page after ID 55. ``` You can also use the `Pagination-Next` header to get the last ID value directly: ```http request # Example header. Pagination-Next: 55 ``` And you can use the `Link` header to get the next page directly without needing to calculate it yourself: ```http request # Example header. Link: ; rel="next" ``` # Filtering **Current filters** If filtering is available for a specific endpoint, 'filter' will be listed as one of the options in the query parameters section of the Request area. Attributes by which you can filter will be listed as well. **How it works** There is a filter mechanism that adheres to some simple conventions. The filters provided on list endpoints, like `filter[email_address]` and `filter[id]` on the `Contacts` list endpoint, need to be "simple" and "fast". These filters are supposed to be easy to use and allow you to filter by one or more concrete values. Here's an example of how you could use the filter to find a contact with a certain email address: ```shell $ curl -g 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?filter[email_address]=you@cf.com' --header 'Authorization: Bearer ...' [{"email_address": "you@cf.com",...}] ``` You can also filter by multiple values: ```shell $ curl -g 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?filter[email_address]=you@cf.com,u2@cf.com' --header 'Authorization: Bearer ...' [{"email_address": "you@cf.com",...}, {"email_address": "u2@cf.com",...}] ``` You can also filter by multiple attributes. Similar to filters that you might be familiar with when using GitHub (e.g.: filtering PRs by closed and assignee), those filters are `AND` filters, which give you the intersection of multiple records: ```shell # If you@cf.com comes with an ID of 1, you will only see this record for this API call: $ curl -g 'https://myteam.myclickfunnels.com/api/v2/workspaces/3/contacts?filter[email_address]=you@cf.com,u2@cf.com&filter[id]=1' --header 'Authorization: Bearer ...' [{"email_address": "you@cf.com",...}] # u2@cf.com is not included because it has a different ID that is not included in the filter. ``` > Please let us know your use case if you need more filter or complex search capabilities, we are > actively improving these areas: https://feedback.myclickfunnels.com/feature-requests?category=api # Webhooks ClickFunnels webhooks allow you to react to many events in the ClickFunnels app on your own server, Zapier and other similar tools. You need to configure one or more endpoints within the ClickFunnels API by using the [Webhooks::Outgoing::Endpoints](https://apidocs.myclickfunnels.com/tag/Webhooks::Outgoing::Endpoint) endpoint with the `event_type_ids` that you want to listen to (see below for all types). Once configured, you will receive POST requrests from us to the configured endpoint URL with the [Webhooks::Outgoing::Event](https://apidocs.myclickfunnels.com/tag/Webhooks::Outgoing::Event#operation/getWebhooksOutgoingEvents) payload, that will contain the subject payload in the `data` property. Like here for the `contact.identified` webhook in V2 version: ```json { "id": null, "public_id": "YVIOwX", "workspace_id": 32, "uuid": "94856650751bb2c141fc38436fd699cb", "event_type_id": "contact.identified", "subject_id": 100, "subject_type": "Contact", "data": { "id": 12, "public_id": "fdPJAZ", "workspace_id": 32, "anonymous": null, "email_address": "joe.doe@example.com", "first_name": "Joe", "last_name": "Doe", "phone_number": "1-241-822-5555", "time_zone": "Pacific Time (US & Canada)", "uuid": "26281ba2-7d3b-524d-8ea3-b01ff8414120", "unsubscribed_at": null, "last_notification_email_sent_at": null, "fb_url": "https://www.facebook.com/example", "twitter_url": "https://twitter.com/example", "instagram_url": "https://instagram.com/example", "linkedin_url": "https://www.linkedin.com/in/example", "website_url": "https://example.com", "created_at": "2023-12-31T18:57:40.871Z", "updated_at": "2023-12-31T18:57:40.872Z", "tags": [ { "id": 20, "public_id": "bRkQrc", "name": "Example Tag", "color": "#59b0a8" } ] }, "created_at": "2023-12-31T18:57:41.872Z" } ``` The content of the `data` property will vary depending on the event type that you are receiving. Event types are structured like this: `subject.action`. So, for a `contact.identified` webhook, your `data` payload will contain data that you can source from [the contact response schema/example in the documentation](https://apidocs.myclickfunnels.com/tag/Contact#operation/getContacts). Similarly, for webhooks like `order.created` and `one-time-order.identified`, you will find the documentation in [the Order resource description](https://apidocs.myclickfunnels.com/tag/Order#operation/getOrders). **Contact webhooks** Are delivered with [the Contact data payload](https://apidocs.myclickfunnels.com/tag/Contact#operation/getContacts). |
Event type
| Versions available | Description | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| | ***Contact*** | | | | `contact.created` | V1, V2 | Sent when a Contact is created | | `contact.updated` | V1, V2 | Sent when a Contact is updated | | `contact.deleted` | V1, V2 | Sent when a Contact is deleted | | `contact.identified` | V1, V2 | Sent when a Contact is identified by email address and/or phone number | | `contact.unsubscribed` | V1, V2 | Sent when a Contact unsubscribes from getting communications from the ClickFunnels workspace | **Contact::AppliedTag webhooks** Are delivered with [the Contact::AppliedTag data payload](https://apidocs.myclickfunnels.com/tag/Contacts::AppliedTag#operation/getContactsAppliedTags) |
Event type
| Versions available | Description | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| | ***Contacts::AppliedTag*** | | | | `contact/applied_tag.created` | V2 | Sent when a Contacts::AppliedTag is created | | `contact/applied_tag.deleted` | V2 | Sent when a Contacts::AppliedTag is deleted **Courses webhooks** Payloads correspond to the respective API resources: - [Course](https://apidocs.myclickfunnels.com/tag/Course#operation/getCourses) - [Courses::Enrollment](https://apidocs.myclickfunnels.com/tag/Courses::Enrollment#operation/getCoursesEnrollments) - [Courses::Section](https://apidocs.myclickfunnels.com/tag/Courses::Section#operation/getCoursesSections) - [Courses::Lesson](https://apidocs.myclickfunnels.com/tag/Courses::Lesson#operation/getCoursesLessons) |
Event type
| Versions available | Description | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| | ***Course*** | | | | `course.created` | V2 | Sent when a Course is created | | `course.updated` | V2 | Sent when a Course is updated | | `course.deleted` | V2 | Sent when a Course is deleted | | `course.published` | V2 | Sent when a Course has been published | | ***Courses::Enrollment*** | | | | `courses/enrollment.created` | V2 | Sent when a Course::Enrollment is created | | `courses/enrollment.updated` | V2 | Sent when a Course::Enrollment is updated | | `courses/enrollment.deleted` | V2 | Sent when a Course::Enrollment is deleted | | `courses/enrollment.suspended` | V2 | Sent when a Course::Enrollment has been suspended | | `courses/enrollment.course_completed` | V2 | Sent when a Course::Enrollment completes a course | | ***Courses::Section*** | | | | `courses/section.created` | V2 | Sent when a Courses::Section is created | | `courses/section.updated` | V2 | Sent when a Courses::Section is updated | | `courses/section.deleted` | V2 | Sent when a Courses::Section is deleted | | `courses/section.published` | V2 | Sent when a Courses::Lesson has been published | | | ***Courses::Lesson*** | | | | `courses/lesson.created` | V2 | Sent when a Courses::Lesson is created | | `courses/lesson.updated` | V2 | Sent when a Courses::Lesson is updated | | `courses/lesson.deleted` | V2 | Sent when a Courses::Lesson is deleted | | `courses/lesson.published` | V2 | Sent when a Courses::Lesson has been published | | | **Form submission webhooks** Currently only available in V1 with the following JSON payload sample: ```json { "data": { "id": "4892034", "type": "form_submission", "attributes": { "id": 9874322, "data": { "action": "submit", "contact": { "email": "joe.doe@example.com", "aff_sub": "43242122e8c15480e9117143ce806d111" }, "controller": "user_pages/pages", "redirect_to": "https://www.example.com/thank-you-newsletter" }, "page_id": 2342324, "contact_id": 234424, "created_at": "2023-11-14T23:25:54.070Z", "updated_at": "2023-11-14T23:25:54.134Z", "workspace_id": 11 } }, "event_id": "bb50ab45-3da8-4532-9d7e-1c85d159ee71", "event_type": "form_submission.created", "subject_id": 9894793, "subject_type": "FormSubmission" } ``` |
Event type
| Versions available | Description | |--------------------------------------------------|--------------------|-----------------------------------------| | ***Form::Submission*** | | | | `form/submission.created` | V1 | Sent when a Form::Submission is created | **Order webhooks** Subscriptions and orders are all of type "Order" and their payload will be as in the [Order resources response payload](https://apidocs.myclickfunnels.com/tag/Order#operation/getOrders). |
Event type
| Versions available | Description | |--------------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------| | ***Order*** | | | | `order.created` | V1, V2 | Sent when an Order has been created | | `order.updated` | V1, V2 | Sent when an Order has been updated | | `order.deleted` | V1, V2 | Sent when an Order has been deleted | | `order.completed` | V1, V2 | Sent when a one-time order was paid or a subscription order's service period has concluded | | ***One-Time Order*** | | | | `one-time-order.completed` | V1, V2 | Sent when an Order of `order_type: "one-time-order"` has been completed | | `one_time_order.refunded` | V1, V2 | Sent when an Order of `order_type: "one-time-order"` refund has been issued | | ***Subscription*** | | | | `subscription.canceled` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been canceled | | `subscription.reactivated` | V1, V2 | Sent when an Order of `order_type: "subscription"` that was canceled was reactivated | | `subscription.downgraded` | V1, V2 | Sent when an Order of `order_type: "subscription"` is changed to a product of smaller value | | `subscription.upgraded` | V1, V2 | Sent when an Order of `order_type: "subscription"` is changed to a product of higher value | | `subscription.churned` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been churned | | `subscription.modified` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been modified | | `subscription.activated` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been activated | | `subscription.completed` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been completed | | `subscription.first_payment_received` | V1, V2 | Sent when an Order of `order_type: "subscription"` received first non-setup payment for subscription item | **Orders::Transaction Webhooks** Orders transactions are currently not part of our V2 API, but you can refer to this sample V2 webhook data payload: ```json { "id": 1821233, "arn": null, "amount": "200.00", "reason": null, "result": "approved", "status": "completed", "currency": "USD", "order_id": 110030, "is_rebill": false, "public_id": "asLOAY", "created_at": "2024-01-30T06:25:06.754Z", "updated_at": "2024-01-30T06:25:06.754Z", "external_id": "txn_01HNCGNQE2C234PCFNERD2AVFZ", "external_type": "sale", "rebill_number": 0, "adjusted_transaction_id": null, "billing_payment_instruction_id": 1333223, "billing_payment_instruction_type": "Billing::PaymentMethod" } ``` |
Event type
| Versions available | Description | |---------------------------------------|--------------------|---------------------------------------------------| | ***Orders::Transaction*** | | | | `orders/transaction.created` | V1, V2 | Sent when an Orders::Transaction has been created | | `orders/transaction.updated` | V1, V2 | Sent when an Orders::Transaction has been updated | **Invoice webhooks** With the [Invoice payload](https://apidocs.myclickfunnels.com/tag/Orders::Invoice). |
Event type
| Versions available | Description | |----------------------------------------------|----------------------|-----------------------------------------------------------------------------| | ***Orders::Invoice*** | | | | `orders/invoice.created` | V1, V2 | Sent when an Orders::Invoice has been created | | `orders/invoice.updated` | V1, V2 | Sent when an Orders::Invoice has been updated | | `orders/invoice.refunded` | V1, V2 | Sent when an Orders::Invoice has been refunded | | `renewal-invoice-payment-declined` | V1, V2 | Issued when a renewal Orders::Invoice payment has been declined | | ***OneTimeOrder::Invoice*** | | | | `one-time-order.invoice.paid` | V1, V2 | Sent when an Order::Invoice of `order_type: "one-time-order"` has been paid | | ***Subscription::Invoice*** | | | | `subscription/invoice.paid` | V1, V2 | Sent when an Order of `order_type: "subscription"` has been paid | **Workflow-based webhooks** These are mostly used for [the UI-based ClickFunnels Workflows functionality](https://support.myclickfunnels.com/support/solutions/articles/150000156983-using-the-webhook-step-in-a-workflow). |
Event type
| Versions available | Description | |--------------------------------------------------|--------------------|--------------------------------------------------------------------| | ***Runs::Step*** | | | | `runs/step.dontrunme` | V1 | Issued when the `dontrunme` step has been ran on a Workflow | | ***Workflows::Integration::Step*** | | | | `workflows_integration_step.executed` | V1 | Sent when a Workflows::Integration::Step has been executed | | ***Workflows::Steps::IntegrationStep*** | | | | `workflows/steps/integration_step.executed` | V1 | Sent when a Workflows::Steps::IntegrationStep has been executed | | ***Workflows::Steps::DeliverWebhookStep*** | | | | `workflows/steps/deliver_webhook_step.executed` | V1 | Sent when a Workflows::Steps::DeliverWebhookStep has been executed | version: V2 termsOfService: https://www.clickfunnels.com/terms-of-service contact: name: ClickFunnels API Team url: https://developers.myclickfunnels.com x-logo: url: >- https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png license: name: MIT url: https://opensource.org/licenses/MIT x-api-status-urls: false servers: - description: ClickFunnels API url: https://{subdomain}.myclickfunnels.com/api/v2 variables: subdomain: default: myworkspace tags: - description: Contacts name: Contact - description: > > Products can be used to create and edit sellable goods. Products have a few boolean attributes including `archived`, `visible_in_store`, and `visible_in_customer_center`. Products that are not `archived` are in a `live` state if they are `visible_in_store` or `visible_in_customer_center` or are associated with any live funnels. `Live` products cannot be archived. Products in an `archived` state can always be unarchived. Each product can have one or more variants expressed as a `Products::Variant`. All products have a "default variant" that acts as a parent to any further variants the product may have. When you create a `Product` we will implicitly create a default variant of type `digital`. If the product you want to create is actually `physical`, be sure to update the type of it's default variant in a subsequent request. The Product Object will always contain a `default_variant_id` attribute that lets you identify the default variant. If the Product will have variants you should set the `variant_properties` attribute to an array of the properties a variant can have (e.g. "Size", "Color", etc.) name: Product - description: > # Contact Tags Contact Tags are unique to each workspace, allowing for customized organization of your Contacts. Once created, these tags can be applied to any contact within the same workspace using the Contacts::AppliedTag endpoint. This API allows you to manage the Contact Tags for your workspace. name: Contacts::Tag - description: Forms name: Form - description: Form FieldSets name: Forms::FieldSet - description: Form Fields name: Forms::Field - description: Form Field Options name: Forms::Fields::Option - description: Form Submissions name: Forms::Submission - description: Form Submission Answers name: Forms::Submissions::Answer - description: > > Images can be used in a variety of use cases. An image can be created or updated from a URL by defining the `upload_source_url` parameter. Once created the ID of an image or of multiple images can be set on a `Product` by defining the `image_ids` parameter as an array of image IDs. > Limitations and Constraints Images have a file size limit of 10MB and a dimension size limit of 10,000 x 10,000 pixels. Image file types currently supported include: ```shell # IMAGE TYPES jpeg, png, webp, x-icon, vnd.microsoft.icon # TEXT TYPES svg+xml, gif ``` Once uploaded, an image will return the following files and sizes | File Description | Width | Height | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| | Thumbnail | 80 | 52 | | Small | 300 | 300 | | Medium | 600 | 600 | | Large | 800 | 800 | | X-Large | 2000 | 2000 | |--------------------------------------------------|--------------------|------------------------------------------------------------------------| name: Image - description: > > Fulfillments allow fulfilling orders and managing shipments. A fulfillment is created when an order or a part of the order is being fulfilled. A created fulfillment always has the status "fulfilled". You can abort a fulfillment by canceling it in which case the status will be the final "cancelled" status. In that case, a new fulfillment can be created to fulfill. Subscription orders may have multiple invoices across the lifetime of the order, so you will want to wait for a subscription-paid event before fulfilling these orders. For non-subscription orders, you can expect that all order invoice line items will be paid with one payment. So you'd usually wait for the payment of a one-time order to have succeeded in which case you can start fulfilling the order. A fulfillment can fully fulfill an order, partially fulfill an order, or contain items from multiple orders. An order can be considered fulfilled once all of its invoice line items have been fulfilled in their according quantities are fulfilled. name: Fulfillment - description: Fulfillment Locations name: Fulfillments::Location - description: > > Order Tags Order Tags are unique to each workspace, allowing for customized organization of your orders. Once created, these tags can be applied to any order within the same workspace. This API allows you to manage the Order Tags for your workspace. name: Orders::Tag - description: Product Tags name: Products::Tag - description: Shipping Package name: Shipping::Package - description: Shipping Profile name: Shipping::Profile - description: Shipping Rate name: Shipping::Rate - description: Shipping Zone name: Shipping::Zone - description: Shipping Rate Names name: Shipping::Rates::Name - description: Webhook Outgoing Endpoints name: Webhooks::Outgoing::Endpoint - description: Workspace name: Workspace - description: >- > Contact Applied Tags The Contact Applied Tags APIs allow you to list, apply and remove tags associated with a specific contact. To utilize this, first obtain the Tag IDs for all the Contact Tags for your workspace via the Contacts::Tags API. You can manage tags for any contact by creating or deleting the corresponding Applied Tags as needed. Note: There is no 'update' method for this API since you should just remove and add a new tag to change them. name: Contacts::AppliedTag - description: > > Controls access to course sections and lessons By purchasing or otherwise opting into a course, an enrollment record is created. Enrollments dictate which sections, sub-sections, and lessons the student can access. Progress for an enrollment can be tracked for a Course, Section, and Lesson. name: Courses::Enrollment - description: > > Order Applied Tags The Order Applied Tags APIs allow you to list, apply and remove tags associated with a specific order. To utilize this, first obtain the Tag IDs for all the Order Tags for your workspace via the Orders::Tag API. You can manage tags for any order by creating or deleting the corresponding Applied Tags as needed. Note: There is no 'update' method for this resource since you should just remove or add a new tag to change them. name: Orders::AppliedTag - description: Product Prices name: Products::Price - description: > > Product variants If there are multiple variants of a product (like when a T-shirt can come in many sizes or colors), then these should be created as `Products::Variant` records related to the `Product` record. When creating a variant it is mandatory to set the `properties_values` so that all the Product's `variant_properties` have a value. All products have a "default variant". Attributes like the below, if left as `null` on a variant (that is not the default) will inherit the value from the default variant: - `product_type` - `sku` - `taxable` - `tax_category_id` - `description` - `weight` - `weight_unit` - `height` - `width` - `length` - `image_id` name: Products::Variant - description: Teams name: Team - description: Users name: User - description: > > Represents the modules within a Course The section is the organization layer of a course where the content is accessed and managed for a customer. Sections can have sub-sections and will have one or more lessons. Access to sections can be managed by the `Courses::Enrollment` and also by the completion of previous sections and lessons. name: Courses::Section - description: > > Represents the material within a Course The lesson is the part of the course which teaches the material described within the course. Completing lessons can unlock access to other lessons or sections within a course. Completing lessons increases the course progress percent. name: Courses::Lesson - description: > > Orders describe a purchase made by a contact. The order's line items reflect all the items that are part of the order which can be a mix between subscriptions and one-time products. You can get insights into and fully manage the subscriptions'/products' life cycle via the respective `Products::Price` and `Products::Variant` endpoints. You will notice that `Orders::Invoice` also includes line items. Invoice line items are different because invoices are a snapshot of an order, but orders can be updated to, for example, upgrade and downgrades subscriptions. The updates will affect future invoices but not past invoices. Currently, only the `notes` field of an order is updatable via the API. Refer to the API refences for details on how you can filter Orders, e.g. by ID or Contact ID name: Order - description: > > Represents the volume of educational material The course is the top-level layer of a concept for educational material. It is the _thing_ to be sold to a customer. Once a customer purchases or otherwise opts into a course, they will be enrolled into the underlying sections and lessons. You can get a broader understanding of the structure of a course by studying the `Courses::Section` and `Courses::Lesson` endpoints. name: Course - description: Form Submissions name: FormSubmission - description: Orders Invoices name: Orders::Invoice - description: > > Restocks make it possible to restock in case a priorly issued fulfillment is not going to be fulfilled. If a customer pays for an invoice that will not get fulfilled (e.g. the invoice may have been refunded), a restock needs to be created so the committed inventory quantity can be returned to available inventory. A restock can also be cancelled, in which case the inventory quantity will be adjusted back. name: Orders::Invoices::Restock - description: Order Transactions name: Orders::Transaction - description: Shipping LocationGroup name: Shipping::LocationGroup - description: Webhooks Outgoing Events name: Webhooks::Outgoing::Event paths: /teams: get: tags: - Team summary: List Teams operationId: Team_getAll description: List all teams for the current account parameters: - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/TeamGetAllResponse' example: - id: 42 public_id: afITAB name: Example Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-03-15T15:33:48.305Z' updated_at: '2024-03-15T15:33:48.305Z' memberships: [] - id: 42 public_id: dJsPeB name: Example Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-03-15T15:33:48.313Z' updated_at: '2024-03-15T15:33:48.314Z' memberships: [] '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/TeamGetAll401Response' example: error: API key missing or invalid /teams/{id}: get: tags: - Team summary: Fetch Team operationId: Team_getSingle description: Retrieve a single team parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamAttributes' example: id: 42 public_id: KnQHwI name: Example Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-03-15T15:33:48.360Z' updated_at: '2024-03-15T15:33:48.360Z' memberships: [] '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/TeamGetSingleResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/TeamGetSingle401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/TeamGetSingle404Response' example: error: 'Not found: Record missing' put: tags: - Team summary: Update Team operationId: Team_updateTeamById description: List all teams for the current account parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Team required: true content: application/json: schema: $ref: '#/components/schemas/TeamUpdateTeamByIdRequest' example: team: name: Example Team time_zone: Pacific Time (US & Canada) locale: en responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TeamAttributes' example: id: 42 public_id: iSrdLK name: Example Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-03-15T15:33:48.411Z' updated_at: '2024-03-15T15:33:48.411Z' memberships: [] '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/TeamUpdateTeamByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/TeamUpdateTeamById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/TeamUpdateTeamById404Response' example: error: 'Not found: Record missing' /users: get: tags: - User summary: List Users operationId: User_listCurrentAccountUsers description: List all users for the current account parameters: - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/UserListCurrentAccountUsersResponse' example: - id: 9 public_id: wUneIZ email: taneka@greenholt-gorczany.io first_name: Ivy last_name: Ernser time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-15T15:33:48.768Z' updated_at: '2024-04-15T15:33:48.768Z' memberships: - id: 10 public_id: vYxaJB team_id: 4 user_id: 9 user_first_name: null user_last_name: null user_profile_photo_id: null user_email: null added_by_id: null platform_agent_of_id: null role_ids: - admin created_at: '2024-04-04T19:23:11.548Z' updated_at: '2024-04-04T19:23:11.641Z' user: id: 4 public_id: WJrGjY name: ClickFunnels time_zone: Eastern Time (US & Canada) locale: en created_at: '2024-04-04T19:22:54.291Z' updated_at: '2024-04-04T19:23:11.645Z' billing_subscriptions: - id: 4 public_id: WYrGvz team_id: 4 status: active cycle_ends_at: null created_at: '2024-04-04T19:25:27.257Z' updated_at: '2024-04-04T19:25:27.257Z' included_prices: - id: 4 subscription_id: 4 price_id: funnel_hacker_monthly_2022 quantity: 1 created_at: '2024-04-04T19:25:27.320Z' updated_at: '2024-04-04T19:25:27.320Z' - id: 10 public_id: mBxCFj email: cole_daugherty@schroeder.co first_name: Tressa last_name: Ryan time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-15T15:33:49.106Z' updated_at: '2024-04-15T15:33:49.106Z' memberships: - id: 11 public_id: OezDJK team_id: 2 user_id: 10 user_first_name: null user_last_name: null user_profile_photo_id: null user_email: noreply+363ee773de9ecd41233f8aec97196f5e@bullettrain.co added_by_id: null platform_agent_of_id: 6 role_ids: - admin created_at: '2024-04-04T19:25:20.596Z' updated_at: '2024-04-04T19:25:20.607Z' user: id: 2 public_id: OjMAjZ name: System Admin Team Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-04T19:21:45.251Z' updated_at: '2024-04-04T19:25:31.612Z' billing_subscriptions: - id: 1 public_id: BvJXjb team_id: 2 status: active cycle_ends_at: null created_at: '2024-04-04T19:21:50.262Z' updated_at: '2024-04-04T19:21:50.262Z' included_prices: - id: 1 subscription_id: 1 price_id: basic_monthly_2022 quantity: 1 created_at: '2024-04-04T19:21:50.312Z' updated_at: '2024-04-04T19:21:50.312Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UserListCurrentAccountUsers401Response' example: error: API key missing or invalid /users/{id}: get: tags: - User summary: Fetch User operationId: User_getSingle description: Retrieve a single user parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserAttributes' example: id: 11 public_id: tBxSwd email: stefani@mcclure-homenick.net first_name: Rolland last_name: Kilback time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-15T15:33:49.554Z' updated_at: '2024-04-15T15:33:49.554Z' memberships: - id: 12 public_id: EYRpjo team_id: 6 user_id: 11 user_first_name: null user_last_name: null user_profile_photo_id: null user_email: noreply+a315900264fc184c1b848af7fe60acb1@bullettrain.co added_by_id: null platform_agent_of_id: 7 role_ids: - admin created_at: '2024-04-04T19:25:28.299Z' updated_at: '2024-04-04T19:25:28.308Z' user: id: 6 public_id: GJPOeQ name: ClickFunnels Internal time_zone: Eastern Time (US & Canada) locale: en created_at: '2024-04-04T19:25:27.333Z' updated_at: '2024-04-04T19:25:30.410Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UserGetSingleResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/UserGetSingle404Response' example: error: User not found put: tags: - User summary: Update User operationId: User_updateSingleUser description: Update a single user parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in User required: true content: application/json: schema: $ref: '#/components/schemas/UserUpdateSingleUserRequest' example: user: email: rosendo.labadie@mckenzie.name first_name: Lawana last_name: Goyette time_zone: Pacific Time (US & Canada) locale: en responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserAttributes' example: id: 13 public_id: FTGKcZ email: rusty_kassulke@schmeler-upton.com first_name: Sonja last_name: Hirthe time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-15T15:33:50.288Z' updated_at: '2024-04-15T15:33:50.288Z' memberships: - id: 16 public_id: ReEoJx team_id: 3 user_id: 13 user_first_name: null user_last_name: null user_profile_photo_id: null user_email: noreply+9df30cea04b86b8f822354d16e415038@bullettrain.co added_by_id: null platform_agent_of_id: 9 role_ids: - admin created_at: '2024-04-04T19:25:47.135Z' updated_at: '2024-04-04T19:25:47.149Z' user: id: 3 public_id: KJkAvg name: My Team Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-04T19:22:51.441Z' updated_at: '2024-04-04T19:25:47.151Z' billing_subscriptions: - id: 2 public_id: OvMAvM team_id: 3 status: active cycle_ends_at: null created_at: '2024-04-04T19:22:54.258Z' updated_at: '2024-04-04T19:22:54.258Z' included_prices: - id: 2 subscription_id: 2 price_id: basic_monthly_2022 quantity: 1 created_at: '2024-04-04T19:22:54.280Z' updated_at: '2024-04-04T19:22:54.280Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/UserUpdateSingleUserResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/UserUpdateSingleUser404Response' example: error: User not found /teams/{team_id}/workspaces: get: tags: - Workspace summary: List Workspaces operationId: Workspace_listWorkspaces description: List workspaces for a team parameters: - name: team_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/WorkspaceListWorkspacesResponse' example: - id: 42 public_id: UFCpkq team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:50.341Z' updated_at: '2024-03-15T15:33:50.341Z' - id: 42 public_id: BEHtaw team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:50.347Z' updated_at: '2024-03-15T15:33:50.347Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WorkspaceListWorkspaces401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/WorkspaceListWorkspaces404Response' example: error: 'Not found: Record missing' post: tags: - Workspace summary: Create Workspace operationId: Workspace_addNew description: Add a new workspace parameters: - name: team_id in: path required: true schema: type: integer requestBody: description: Information about a new Workspace required: true content: application/json: schema: $ref: '#/components/schemas/WorkspaceAddNewRequest' example: workspace: name: Example Workspace subdomain: example responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WorkspaceAttributes' example: id: 42 public_id: XzSvsb team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:50.376Z' updated_at: '2024-03-15T15:33:50.376Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/WorkspaceAddNewResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WorkspaceAddNew401Response' example: error: API key missing or invalid /workspaces/{id}: get: tags: - Workspace summary: Fetch Workspace operationId: Workspace_getById description: Retrieve a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkspaceAttributes' example: id: 42 public_id: CJSZfB team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:50.363Z' updated_at: '2024-03-15T15:33:50.363Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WorkspaceGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/WorkspaceGetById404Response' example: error: 'Not found: Record missing' put: tags: - Workspace summary: Update Workspace operationId: Workspace_update description: Update a workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Workspace required: true content: application/json: schema: $ref: '#/components/schemas/WorkspaceUpdateRequest' example: workspace: name: Example Workspace subdomain: example responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkspaceAttributes' example: id: 42 public_id: WiCwpY team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:50.402Z' updated_at: '2024-03-15T15:33:50.402Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/WorkspaceUpdateResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WorkspaceUpdate401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/WorkspaceUpdate404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/contacts: get: tags: - Contact summary: List Contacts operationId: Contact_listForWorkspace description: >- List contacts for the given workspace. By default, only identified contacts are shown so you won't see anonymous or GDPR-redacted contacts. parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - description: >- Filtering - Keep in mind that depending on the tools that you use, you might run into different situations where additional encoding is needed. For example: - You might need to encode `filter[id]=1` as `filter%5Bid%5D=1` or use special options in your tools of choice to do it for you (like `g` in CURL). - Special URL characters like `%`, `+`, or unicode characters in emails (like Chinese characters) will need additional encoding. name: filter in: query required: false schema: type: object properties: email_address: description: A comma-separated list of email addresses to filter by. type: string example: russel@clickfunnels.com,todd@clickfunnels.com id: description: A comma-separated list of contact IDs to filter by. type: string example: 142 style: deepObject explode: true responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ContactListForWorkspaceResponse' example: - tags: - id: 20 public_id: ikmIPb name: Example Tag color: '#bb74f8' id: 18 public_id: mTKAfR workspace_id: 42 anonymous: null email_address: test-a3026bff99dc1def8054@example.com first_name: Rodger last_name: Murazik phone_number: 241-973-9779 x6953 time_zone: Pacific Time (US & Canada) uuid: 0a301029-6721-4751-a5d9-3c93beb39e74 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.519Z' updated_at: '2024-03-15T15:33:50.519Z' - tags: - id: 21 public_id: hKTuRe name: Example Tag color: '#b4219d' id: 19 public_id: HvDNId workspace_id: 42 anonymous: null email_address: test-4d507c7f5a1a25ca5438@example.com first_name: Marcelo last_name: Cronin phone_number: (612) 601-9768 x5743 time_zone: Pacific Time (US & Canada) uuid: fa62ae2a-fbe6-4576-a017-8fc38fd90c32 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.534Z' updated_at: '2024-03-15T15:33:50.534Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactListForWorkspace401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactListForWorkspace404Response' example: error: 'Not found: Record missing' post: tags: - Contact summary: Create Contact operationId: Contact_createNewContact description: Add a new contact to the workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Contact required: true content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewContactRequest' example: contact: email_address: test-3c42448ea5919cd28adc@example.com first_name: Quinn last_name: Hand phone_number: 785.922.2900 time_zone: Pacific Time (US & Canada) fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ContactAttributes' example: tags: - id: 23 public_id: YoxAwC name: Example Tag color: '#9cc161' id: 21 public_id: RVxwED workspace_id: 42 anonymous: null email_address: test-53014ddc0055ec80c026@example.com first_name: Devon last_name: Crona phone_number: (695) 294-3727 x5702 time_zone: Pacific Time (US & Canada) uuid: 4d2d5c42-bb47-4e21-8fc4-9db0787f1cc1 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.581Z' updated_at: '2024-03-15T15:33:50.581Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewContactResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactCreateNewContact401Response' example: error: API key missing or invalid /contacts/{id}: get: tags: - Contact summary: Fetch Contact operationId: Contact_getContactById description: Retrieve a contact parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactAttributes' example: tags: - id: 22 public_id: dXZOGh name: Example Tag color: '#6cb651' id: 20 public_id: AunLoX workspace_id: 42 anonymous: null email_address: test-24cc7d6309b81363cfe0@example.com first_name: Chrystal last_name: Bode phone_number: 590-565-4805 time_zone: Pacific Time (US & Canada) uuid: 7b4aec1b-ea72-4a6f-a62d-7339b9d700cf unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.562Z' updated_at: '2024-03-15T15:33:50.562Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactGetContactByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactGetContactById404Response' example: error: 'Not found: Record missing' put: tags: - Contact summary: Update Contact operationId: Contact_updateContactById description: Update a contact parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Contact required: true content: application/json: schema: $ref: '#/components/schemas/ContactUpdateContactByIdRequest' example: contact: email_address: test-e8101c655627f27120a3@example.com first_name: Norma last_name: Lind phone_number: 654-790-6096 x887 time_zone: Pacific Time (US & Canada) fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactAttributes' example: tags: - id: 25 public_id: OvKBgA name: Example Tag color: '#179a79' id: 23 public_id: lckpHy workspace_id: 42 anonymous: null email_address: test-55102d2aa5ec857b77c5@example.com first_name: Dominick last_name: Lakin phone_number: 321-464-2014 x49156 time_zone: Pacific Time (US & Canada) uuid: 6d018fce-296b-4fa4-96ce-39c2ab34326f unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.620Z' updated_at: '2024-03-15T15:33:50.620Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ContactUpdateContactByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactUpdateContactById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactUpdateContactById404Response' example: error: 'Not found: Record missing' delete: tags: - Contact summary: Remove Contact operationId: Contact_removeById description: Delete a contact parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactRemoveById404Response' example: error: 'Not found: Record missing' /contacts/{id}/gdpr_destroy: delete: tags: - Contact summary: Redact Contact operationId: Contact_redactPersonallyIdentifiable description: >- This will destroy all personally identifiable information for a contact, including their name and phone number, but does not delete the contact record iteself. This cannot be undone. parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK '404': description: Not Found /workspaces/{workspace_id}/contacts/upsert: post: tags: - Contact summary: Upsert a Contact operationId: Contact_upsert description: >- Creates or updates a Contact, matching on the email address. If the Contact does not exist, it will be created. If the Contact does exist, it will be updated. It is not possible to delete a Contact via this endpoint. It is not possible to reset properties of a Contact by passing empty values. E.g. passing `null` for `first_name` or an empty array for `tag_ids` won't update previous values. To do that you would instead need to use the `Update Contact` endpoint. parameters: - name: workspace_id in: path required: true schema: type: string requestBody: description: >- Contact to create or update, matching on the email address. Note that properties of a Contact are not reset when passed empty values, e.g. passing `null` for `first_name` or an empty array for `tag_ids` won't update previous values. To do that you would instead use the `Update Contact` endpoint. required: true content: application/json: schema: $ref: '#/components/schemas/ContactUpsertRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactUpsertResponse' example: tags: - id: 18 public_id: PWjfxq name: Example Tag color: '#c53c0d' id: 16 public_id: VxflLO workspace_id: 42 anonymous: null email_address: test-1ca6e66c00f2d85f311f@example.com first_name: Karry last_name: Emmerich phone_number: 1-509-992-2238 x9236 time_zone: Pacific Time (US & Canada) uuid: d02a64da-8b7f-47fc-b9b6-c9f1d259d9c4 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.473Z' updated_at: '2024-03-15T15:33:50.473Z' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ContactUpsert201Response' example: tags: - id: 19 public_id: eAJkit name: Example Tag color: '#cafb4c' id: 17 public_id: XzJYiU workspace_id: 42 anonymous: null email_address: test-4a5d3256bac7cd39d843@example.com first_name: Ali last_name: Thompson phone_number: 1-741-007-2047 time_zone: Pacific Time (US & Canada) uuid: b4fa334f-2521-4f02-8048-152cd697c99d unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:50.497Z' updated_at: '2024-03-15T15:33:50.497Z' '422': description: Unprocessable Entity /contacts/{contact_id}/applied_tags: get: tags: - Contacts::AppliedTag summary: List Applied Tags operationId: ContactsAppliedTag_list description: List the applied tags for a contact parameters: - name: contact_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagListResponse' example: - id: 2 public_id: vdbIxJ contact_id: 27 tag_id: 30 created_at: '2024-04-08T15:33:50.736Z' updated_at: '2024-04-08T15:33:50.736Z' - id: 3 public_id: luvYSX contact_id: 28 tag_id: 32 created_at: '2024-04-08T15:33:50.754Z' updated_at: '2024-04-08T15:33:50.754Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagList404Response' example: error: 'Not found: Record missing' post: tags: - Contacts::AppliedTag summary: Create Applied Tag operationId: ContactsAppliedTag_createAppliedTag description: Assign a tag to a contact by creating an applied tag parameters: - name: contact_id in: path required: true schema: type: integer requestBody: description: Information about a new Applied Tag required: true content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagCreateAppliedTagRequest' example: contacts_applied_tag: tag_id: 38 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagAttributes' example: id: 5 public_id: waKoHg contact_id: 30 tag_id: 36 created_at: '2024-04-08T15:33:50.813Z' updated_at: '2024-04-08T15:33:50.813Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/ContactsAppliedTagCreateAppliedTagResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ContactsAppliedTagCreateAppliedTag401Response example: error: API key missing or invalid /contacts/applied_tags/{id}: get: tags: - Contacts::AppliedTag summary: Fetch Applied Tag operationId: ContactsAppliedTag_getForContact description: Retrieve an applied tag for a contact parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagAttributes' example: id: 4 public_id: cuXpEf contact_id: 29 tag_id: 34 created_at: '2024-04-08T15:33:50.787Z' updated_at: '2024-04-08T15:33:50.787Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagGetForContactResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ContactsAppliedTagGetForContact404Response example: error: 'Not found: Record missing' delete: tags: - Contacts::AppliedTag summary: Remove Applied Tag operationId: ContactsAppliedTag_removeById description: Remove a tag from a contact by deleting an applied tag parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsAppliedTagRemoveById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/contacts/tags: get: tags: - Contacts::Tag summary: List Tags operationId: ContactsTag_list description: List all Contact Tags for your workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ContactsTagListResponse' example: - id: 47 public_id: DjaAbu workspace_id: 42 name: Example Tag color: '#39bbea' created_at: '2024-04-15T15:33:50.979Z' updated_at: '2024-04-15T15:33:50.979Z' - id: 48 public_id: GyOnsY workspace_id: 42 name: Example Tag color: '#b0f363' created_at: '2024-04-15T15:33:50.986Z' updated_at: '2024-04-15T15:33:50.986Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsTagList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsTagList404Response' example: error: 'Not found: Record missing' post: tags: - Contacts::Tag summary: Create Tag operationId: ContactsTag_createNewTag description: Add a new Contact Tag to your Workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Tag required: true content: application/json: schema: $ref: '#/components/schemas/ContactsTagCreateNewTagRequest' example: contacts_tag: name: Example Tag color: '#12700b' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ContactsTagAttributes' example: id: 50 public_id: VeqdGr workspace_id: 42 name: Example Tag color: '#f6cf81' created_at: '2024-04-15T15:33:51.025Z' updated_at: '2024-04-15T15:33:51.025Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ContactsTagCreateNewTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsTagCreateNewTag401Response' example: error: API key missing or invalid /contacts/tags/{id}: get: tags: - Contacts::Tag summary: Fetch Tag operationId: ContactsTag_getSingle description: Retrieve a single Contact Tag parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactsTagAttributes' example: id: 49 public_id: IFUMhC workspace_id: 42 name: Example Tag color: '#2ae934' created_at: '2024-04-15T15:33:51.009Z' updated_at: '2024-04-15T15:33:51.009Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsTagGetSingleResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsTagGetSingle404Response' example: error: 'Not found: Record missing' put: tags: - Contacts::Tag summary: Update Tag operationId: ContactsTag_updateSpecificTag description: Update a Contact Tag parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Tag required: true content: application/json: schema: $ref: '#/components/schemas/ContactsTagUpdateSpecificTagRequest' example: contacts_tag: name: Example Tag color: '#3f4b35' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContactsTagAttributes' example: id: 52 public_id: aTYGrS workspace_id: 42 name: Example Tag color: '#d62434' created_at: '2024-04-15T15:33:51.054Z' updated_at: '2024-04-15T15:33:51.054Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ContactsTagUpdateSpecificTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsTagUpdateSpecificTag401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsTagUpdateSpecificTag404Response' example: error: 'Not found: Record missing' delete: tags: - Contacts::Tag summary: Remove Tag operationId: ContactsTag_remove description: Delete a Contact Tag from your workspace parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ContactsTagRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ContactsTagRemove404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/courses: get: tags: - Course summary: List Courses operationId: Course_listForWorkspace description: List courses for a team parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/CourseListForWorkspaceResponse' example: - title: Example Course description: >- Mollitia cumque ut. Minima asperiores provident. Quae sint incidunt. id: 3 public_id: dItDac published_at: '2024-04-08T15:33:51.000Z' root_section_id: null current_path: null sharing_fingerprint: null show_in_community: false show_to_non_members: false upgrade_url: null redirect_to_full_course: true unauthorized_redirect_url: null comments_enabled: false created_at: '2024-04-08T15:33:51.134Z' updated_at: '2024-04-08T15:33:51.134Z' - title: Example Course description: Neque eius qui. Ut error est. Nobis qui nihil. id: 4 public_id: MFSJuv published_at: '2024-04-08T15:33:51.000Z' root_section_id: null current_path: null sharing_fingerprint: null show_in_community: false show_to_non_members: false upgrade_url: null redirect_to_full_course: true unauthorized_redirect_url: null comments_enabled: false created_at: '2024-04-08T15:33:51.188Z' updated_at: '2024-04-08T15:33:51.188Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CourseListForWorkspace401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CourseListForWorkspace404Response' example: error: 'Not found: Record missing' /courses/{id}: get: tags: - Course summary: Fetch Course operationId: Course_getById description: Retrieve a course parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CourseAttributes' example: title: Example Course description: >- Beatae perspiciatis quam. Dolorem aspernatur libero. Qui sint quia. id: 5 public_id: UjXtdN published_at: '2024-04-08T15:33:51.000Z' root_section_id: null current_path: null sharing_fingerprint: null show_in_community: false show_to_non_members: false upgrade_url: null redirect_to_full_course: true unauthorized_redirect_url: null comments_enabled: false created_at: '2024-04-08T15:33:51.473Z' updated_at: '2024-04-08T15:33:51.474Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CourseGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CourseGetById404Response' example: error: 'Not found: Record missing' /courses/{course_id}/enrollments: get: tags: - Courses::Enrollment summary: List Enrollments operationId: CoursesEnrollment_list description: List enrollments for a course parameters: - name: course_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentListResponse' example: - id: 2 public_id: DszxQn contact_id: 36 course_id: 12 created_at: '2024-02-15T15:33:52.556Z' updated_at: '2024-03-15T15:33:52.556Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/df0fde007b97fce8d3bd2dd9d578edce2e9f4624b268cdfcf603031677873e02c5 origination_source_type: Membership origination_source_id: 2 - id: 3 public_id: mNvGYE contact_id: 37 course_id: 13 created_at: '2024-02-15T15:33:52.935Z' updated_at: '2024-03-15T15:33:52.935Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/a1c2a0370e2d0b90d6d53dd839a1f2c212557c5c8c048a9ea48af8616e23b77ebd origination_source_type: Membership origination_source_id: 3 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentList404Response' example: error: 'Not found: Record missing' post: tags: - Courses::Enrollment summary: Create Enrollment operationId: CoursesEnrollment_createNewEnrollment description: Add a new enrollment parameters: - name: course_id in: path required: true schema: type: integer requestBody: description: Information about a new Enrollment required: true content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentCreateNewEnrollmentRequest' example: courses_enrollment: contact_id: 40 suspended: false suspension_reason: Call in to reapply after robot incident responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentAttributes' example: id: 5 public_id: ikvxoe contact_id: 39 course_id: 15 created_at: '2024-02-15T15:33:53.739Z' updated_at: '2024-03-15T15:33:53.739Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/250d52bea03ff610a9b4c1e09ace5333ebf4a7ad0ea736945f54dfd6bbec785d6d origination_source_type: Membership origination_source_id: 5 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentCreateNewEnrollmentResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentCreateNewEnrollment401Response example: error: API key missing or invalid /courses/enrollments/{id}: get: tags: - Courses::Enrollment summary: Fetch Enrollment operationId: CoursesEnrollment_getById description: Retrieve an enrollment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentAttributes' example: id: 4 public_id: MhnZyD contact_id: 38 course_id: 14 created_at: '2024-02-15T15:33:53.332Z' updated_at: '2024-03-15T15:33:53.332Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/05a5186e5f045eff61629ee5dcf663ac921bacfee649cbcfcd33f954b0105f2a28 origination_source_type: Membership origination_source_id: 4 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentGetById404Response' example: error: 'Not found: Record missing' put: tags: - Courses::Enrollment summary: Update Enrollment operationId: CoursesEnrollment_updateSpecificEnrollment description: Update an enrollment parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Enrollment required: true content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentUpdateSpecificEnrollmentRequest example: courses_enrollment: contact_id: 42 suspended: false suspension_reason: Call in to reapply after robot incident responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesEnrollmentAttributes' example: id: 7 public_id: apJEOy contact_id: 41 course_id: 17 created_at: '2024-02-15T15:33:54.525Z' updated_at: '2024-03-15T15:33:54.525Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/3ca55c8d07a5f9863c92f6fe1ebf63df705543b4dc598b78df12d13e8e6c39ee3d origination_source_type: Membership origination_source_id: 7 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentUpdateSpecificEnrollmentResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentUpdateSpecificEnrollment401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/CoursesEnrollmentUpdateSpecificEnrollment404Response example: error: 'Not found: Record missing' /courses/{course_id}/sections: get: tags: - Courses::Section summary: List Sections operationId: CoursesSection_listSections description: List Sections parameters: - name: course_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/CoursesSectionListSectionsResponse' example: - title: Module 2 description: null id: null public_id: EYqVpI course_id: null published_at: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null current_path: null is_hidden_from_non_members: true upgrade_url: null created_at: null updated_at: null - title: Module 3 description: null id: null public_id: GbozWD course_id: null published_at: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null current_path: null is_hidden_from_non_members: true upgrade_url: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesSectionListSections401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesSectionListSections404Response' example: error: 'Not found: Record missing' /courses/sections/{id}: get: tags: - Courses::Section summary: Fetch Section operationId: CoursesSection_getSection description: Fetch Section parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesSectionAttributes' example: title: Module 4 description: null id: null public_id: fqFVMH course_id: null published_at: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null current_path: null is_hidden_from_non_members: true upgrade_url: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesSectionGetSectionResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesSectionGetSection404Response' example: error: 'Not found: Record missing' put: tags: - Courses::Section summary: Update Section operationId: CoursesSection_updateSectionById description: Update Section parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Section required: true content: application/json: schema: $ref: '#/components/schemas/CoursesSectionUpdateSectionByIdRequest' example: courses_section: title: Module 8 description: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null is_hidden_from_non_members: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesSectionAttributes' example: title: Module 7 description: null id: null public_id: ldEKMi course_id: null published_at: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null current_path: null is_hidden_from_non_members: true upgrade_url: null created_at: null updated_at: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/CoursesSectionUpdateSectionByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/CoursesSectionUpdateSectionById401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/CoursesSectionUpdateSectionById404Response example: error: 'Not found: Record missing' /courses/sections/{section_id}/lessons: get: tags: - Courses::Lesson summary: List Lessons operationId: CoursesLesson_listLessons description: List Lessons parameters: - name: section_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/CoursesLessonListLessonsResponse' example: - title: Lesson 2 id: null public_id: OAzJBT body: null section_id: null published_at: null current_path: null created_at: null updated_at: null - title: Lesson 3 id: null public_id: TtmFKq body: null section_id: null published_at: null current_path: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesLessonListLessons401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesLessonListLessons404Response' example: error: 'Not found: Record missing' /courses/lessons/{id}: get: tags: - Courses::Lesson summary: Fetch Lesson operationId: CoursesLesson_getById description: Fetch Lesson parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesLessonAttributes' example: title: Lesson 4 id: null public_id: RGXokC body: null section_id: null published_at: null current_path: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesLessonGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesLessonGetById404Response' example: error: 'Not found: Record missing' put: tags: - Courses::Lesson summary: Update Lesson operationId: CoursesLesson_updateLessonById description: Update Lesson parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Lesson required: true content: application/json: schema: $ref: '#/components/schemas/CoursesLessonUpdateLessonByIdRequest' example: courses_lesson: title: Lesson 8 body: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CoursesLessonAttributes' example: title: Lesson 7 id: null public_id: otdXlp body: null section_id: null published_at: null current_path: null created_at: null updated_at: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/CoursesLessonUpdateLessonByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/CoursesLessonUpdateLessonById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/CoursesLessonUpdateLessonById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/forms: get: tags: - Form summary: List Forms operationId: Form_listWorkspaceForms description: List forms for a workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormListWorkspaceFormsResponse' example: - id: 9 public_id: ZtShVD workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:55.811Z' updated_at: '2024-04-15T15:33:55.811Z' - id: 10 public_id: yBbDjT workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:55.825Z' updated_at: '2024-04-15T15:33:55.825Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormListWorkspaceForms401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormListWorkspaceForms404Response' example: error: 'Not found: Record missing' post: tags: - Form summary: Create Form operationId: Form_createNewForm description: Add a new form parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Form required: true content: application/json: schema: $ref: '#/components/schemas/FormCreateNewFormRequest' example: form: name: Example Form responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormAttributes' example: id: 12 public_id: cliEqH workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:55.859Z' updated_at: '2024-04-15T15:33:55.859Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormCreateNewFormResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormCreateNewForm401Response' example: error: API key missing or invalid /forms/{id}: get: tags: - Form summary: Fetch Form operationId: Form_getForm description: Retrieve a form parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormAttributes' example: id: 11 public_id: AagszE workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:55.845Z' updated_at: '2024-04-15T15:33:55.845Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormGetFormResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormGetForm404Response' example: error: 'Not found: Record missing' put: tags: - Form summary: Update Form operationId: Form_updateFormById description: Update a form parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Form required: true content: application/json: schema: $ref: '#/components/schemas/FormUpdateFormByIdRequest' example: form: name: Example Form responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormAttributes' example: id: 14 public_id: bWhZzm workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:55.883Z' updated_at: '2024-04-15T15:33:55.883Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormUpdateFormByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormUpdateFormById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormUpdateFormById404Response' example: error: 'Not found: Record missing' delete: tags: - Form summary: Remove Form operationId: Form_remove description: Delete a form parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormRemove404Response' example: error: 'Not found: Record missing' /forms/{form_id}/field_sets: get: tags: - Forms::FieldSet summary: List Field Sets operationId: FormsFieldSet_list description: List field sets for a form parameters: - name: form_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetListResponse' example: - title: Example Field Set id: 5 public_id: ZFjPWG form_id: 18 created_at: '2024-04-15T15:33:55.943Z' updated_at: '2024-04-15T15:33:55.943Z' - title: Example Field Set id: 6 public_id: cBPfEy form_id: 19 created_at: '2024-04-15T15:33:55.950Z' updated_at: '2024-04-15T15:33:55.950Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetList404Response' example: error: 'Not found: Record missing' post: tags: - Forms::FieldSet summary: Create Field Set operationId: FormsFieldSet_createNewFieldSet description: Add a new field set parameters: - name: form_id in: path required: true schema: type: integer requestBody: description: Information about a new Field Set required: true content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetCreateNewFieldSetRequest' example: forms_field_set: title: Example Field Set responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetAttributes' example: title: Example Field Set id: 8 public_id: HDjomy form_id: 21 created_at: '2024-04-15T15:33:55.981Z' updated_at: '2024-04-15T15:33:55.981Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetCreateNewFieldSetResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetCreateNewFieldSet401Response' example: error: API key missing or invalid /forms/field_sets/{id}: get: tags: - Forms::FieldSet summary: Fetch Field Set operationId: FormsFieldSet_getFieldSet description: Retrieve a field set parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetAttributes' example: title: Example Field Set id: 7 public_id: IXTbhc form_id: 20 created_at: '2024-04-15T15:33:55.968Z' updated_at: '2024-04-15T15:33:55.968Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetGetFieldSetResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetGetFieldSet404Response' example: error: 'Not found: Record missing' put: tags: - Forms::FieldSet summary: Update Field Set operationId: FormsFieldSet_updateFieldSetById description: Update a field set parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Field Set required: true content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetUpdateFieldSetByIdRequest' example: forms_field_set: title: Example Field Set responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetAttributes' example: title: Example Field Set id: 10 public_id: wrPgqN form_id: 23 created_at: '2024-04-15T15:33:56.006Z' updated_at: '2024-04-15T15:33:56.006Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetUpdateFieldSetByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsFieldSetUpdateFieldSetById401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsFieldSetUpdateFieldSetById404Response example: error: 'Not found: Record missing' delete: tags: - Forms::FieldSet summary: Remove Field Set operationId: FormsFieldSet_remove description: Delete a field set parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldSetRemove404Response' example: error: 'Not found: Record missing' /forms/field_sets/{field_set_id}/fields: get: tags: - Forms::Field summary: List Fields operationId: FormsField_listFieldsForFieldSet description: List fields for a field set parameters: - name: field_set_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormsFieldListFieldsForFieldSetResponse' example: - id: 4 public_id: fTcJvn field_set_id: 14 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:56.072Z' updated_at: '2024-04-15T15:33:56.072Z' - id: 5 public_id: kQpwOC field_set_id: 15 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:56.090Z' updated_at: '2024-04-15T15:33:56.090Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsFieldListFieldsForFieldSet401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsFieldListFieldsForFieldSet404Response example: error: 'Not found: Record missing' post: tags: - Forms::Field summary: Create Field operationId: FormsField_addNewField description: Add a new field parameters: - name: field_set_id in: path required: true schema: type: integer requestBody: description: Information about a new Field required: true content: application/json: schema: $ref: '#/components/schemas/FormsFieldAddNewFieldRequest' example: forms_field: label: MyString field_type: MyString allow_multiple: false key: null hidden: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormsFieldAttributes' example: id: 7 public_id: JbPtrg field_set_id: 17 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:56.150Z' updated_at: '2024-04-15T15:33:56.150Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormsFieldAddNewFieldResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldAddNewField401Response' example: error: API key missing or invalid /forms/fields/{id}: get: tags: - Forms::Field summary: Fetch Field operationId: FormsField_getField description: Retrieve a field parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldAttributes' example: id: 6 public_id: GAMcFl field_set_id: 16 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:56.123Z' updated_at: '2024-04-15T15:33:56.123Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldGetFieldResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldGetField404Response' example: error: 'Not found: Record missing' put: tags: - Forms::Field summary: Update Field operationId: FormsField_updateFieldById description: Update a field parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Field required: true content: application/json: schema: $ref: '#/components/schemas/FormsFieldUpdateFieldByIdRequest' example: forms_field: label: MyString field_type: MyString allow_multiple: false key: null hidden: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldAttributes' example: id: 9 public_id: twKaVq field_set_id: 19 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:56.199Z' updated_at: '2024-04-15T15:33:56.199Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormsFieldUpdateFieldByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldUpdateFieldById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldUpdateFieldById404Response' example: error: 'Not found: Record missing' delete: tags: - Forms::Field summary: Remove Field operationId: FormsField_removeField description: Delete a field parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldRemoveFieldResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldRemoveField404Response' example: error: 'Not found: Record missing' /forms/fields/{field_id}/options: get: tags: - Forms::Fields::Option summary: List Options operationId: FormsFieldsOption_list description: List options for a field parameters: - name: field_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionListResponse' example: - id: 30 public_id: cxqwOM field_id: 13 label: repellendus created_at: '2024-04-15T15:33:56.325Z' updated_at: '2024-04-15T15:33:56.325Z' - id: 33 public_id: CMqzPy field_id: 14 label: alias created_at: '2024-04-15T15:33:56.345Z' updated_at: '2024-04-15T15:33:56.345Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionList404Response' example: error: 'Not found: Record missing' post: tags: - Forms::Fields::Option summary: Create Option operationId: FormsFieldsOption_createNewFieldOption description: Add a new option to a field parameters: - name: field_id in: path required: true schema: type: integer requestBody: description: Information about a new Option required: true content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionCreateNewFieldOptionRequest example: forms_fields_option: label: praesentium responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionAttributes' example: id: 39 public_id: KRSMVa field_id: 16 label: laudantium created_at: '2024-04-15T15:33:56.403Z' updated_at: '2024-04-15T15:33:56.403Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionCreateNewFieldOptionResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionCreateNewFieldOption401Response example: error: API key missing or invalid /forms/fields/options/{id}: get: tags: - Forms::Fields::Option summary: Fetch Option operationId: FormsFieldsOption_getFieldOption description: Retrieve a option for a field parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionAttributes' example: id: 36 public_id: mXgnEO field_id: 15 label: quam created_at: '2024-04-15T15:33:56.376Z' updated_at: '2024-04-15T15:33:56.376Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionGetFieldOptionResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionGetFieldOption404Response example: error: 'Not found: Record missing' put: tags: - Forms::Fields::Option summary: Update Option operationId: FormsFieldsOption_updateFieldOption description: Update a option for a field parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Option required: true content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionUpdateFieldOptionRequest' example: forms_fields_option: label: quos responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsFieldsOptionAttributes' example: id: 45 public_id: uwYKkS field_id: 18 label: nobis created_at: '2024-04-15T15:33:56.454Z' updated_at: '2024-04-15T15:33:56.454Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionUpdateFieldOptionResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionUpdateFieldOption401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionUpdateFieldOption404Response example: error: 'Not found: Record missing' delete: tags: - Forms::Fields::Option summary: Remove Option operationId: FormsFieldsOption_deleteOptionForField description: Delete a option for a field parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionDeleteOptionForFieldResponse example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsFieldsOptionDeleteOptionForField404Response example: error: 'Not found: Record missing' /forms/{form_id}/submissions: get: tags: - Forms::Submission summary: List Submissions operationId: FormsSubmission_list description: List submissions for a form parameters: - name: form_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionListResponse' example: - id: 3 public_id: pMHRQC form_id: 63 contact_id: 45 created_at: '2024-04-15T15:33:56.594Z' updated_at: '2024-04-15T15:33:56.594Z' - id: 4 public_id: pDklra form_id: 64 contact_id: 46 created_at: '2024-04-15T15:33:56.612Z' updated_at: '2024-04-15T15:33:56.612Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionList404Response' example: error: 'Not found: Record missing' post: tags: - Forms::Submission summary: Create Submission operationId: FormsSubmission_createNewSubmission description: Add a new submission to a form parameters: - name: form_id in: path required: true schema: type: integer requestBody: description: Information about a new Submission required: true content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionCreateNewSubmissionRequest' example: forms_submission: contact_id: 49 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionAttributes' example: id: 6 public_id: SYvieJ form_id: 66 contact_id: 48 created_at: '2024-04-15T15:33:56.672Z' updated_at: '2024-04-15T15:33:56.672Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionCreateNewSubmissionResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionCreateNewSubmission401Response example: error: API key missing or invalid /forms/submissions/{id}: get: tags: - Forms::Submission summary: Fetch Submission operationId: FormsSubmission_getById description: Retrieve a submission for a form parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionAttributes' example: id: 5 public_id: zHMCmL form_id: 65 contact_id: 47 created_at: '2024-04-15T15:33:56.645Z' updated_at: '2024-04-15T15:33:56.645Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionGetById404Response' example: error: 'Not found: Record missing' put: tags: - Forms::Submission summary: Update Submission operationId: FormsSubmission_updateSubmission description: Update a submission for a form parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Submission required: true content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionUpdateSubmissionRequest' example: forms_submission: contact_id: 51 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionAttributes' example: id: 8 public_id: NOiGpm form_id: 68 contact_id: 50 created_at: '2024-04-15T15:33:56.723Z' updated_at: '2024-04-15T15:33:56.724Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionUpdateSubmissionResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionUpdateSubmission401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionUpdateSubmission404Response example: error: 'Not found: Record missing' delete: tags: - Forms::Submission summary: Remove Submission operationId: FormsSubmission_remove description: Delete a submission for a form parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionRemove404Response' example: error: 'Not found: Record missing' /forms/submissions/{submission_id}/answers: get: tags: - Forms::Submissions::Answer summary: List Answers operationId: FormsSubmissionsAnswer_list description: List answers for a submission parameters: - name: submission_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerListResponse' example: - id: 2 public_id: sVTpSv submission_id: 12 field_id: 22 fields_option_id: 57 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:56.853Z' updated_at: '2024-04-15T15:33:56.853Z' - id: 3 public_id: EjTDoz submission_id: 13 field_id: 23 fields_option_id: 61 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:56.881Z' updated_at: '2024-04-15T15:33:56.881Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerList404Response' example: error: 'Not found: Record missing' post: tags: - Forms::Submissions::Answer summary: Create Answer operationId: FormsSubmissionsAnswer_addNewAnswer description: Add a new answer to a submission parameters: - name: submission_id in: path required: true schema: type: integer requestBody: description: Information about a new Answer required: true content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerAddNewAnswerRequest' example: forms_submissions_answer: field_id: 26 fields_option_id: 73 entry: MyText fields_option_ids: [] responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerAttributes' example: id: 5 public_id: SfyjYs submission_id: 15 field_id: 25 fields_option_id: 69 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:56.983Z' updated_at: '2024-04-15T15:33:56.983Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerAddNewAnswerResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerAddNewAnswer401Response example: error: API key missing or invalid /forms/submissions/answers/{id}: get: tags: - Forms::Submissions::Answer summary: Fetch Answer operationId: FormsSubmissionsAnswer_get description: Retrieve a answer for a submission parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerAttributes' example: id: 4 public_id: NJrPQh submission_id: 14 field_id: 24 fields_option_id: 65 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:56.940Z' updated_at: '2024-04-15T15:33:56.940Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerGetResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerGet404Response' example: error: 'Not found: Record missing' put: tags: - Forms::Submissions::Answer summary: Update Answer operationId: FormsSubmissionsAnswer_updateAnswer description: Update a answer for a submission parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Answer required: true content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerUpdateAnswerRequest' example: forms_submissions_answer: field_id: 28 fields_option_id: 81 entry: MyText fields_option_ids: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerAttributes' example: id: 7 public_id: vxQYjd submission_id: 17 field_id: 27 fields_option_id: 77 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:57.059Z' updated_at: '2024-04-15T15:33:57.059Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerUpdateAnswerResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerUpdateAnswer401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerUpdateAnswer404Response example: error: 'Not found: Record missing' delete: tags: - Forms::Submissions::Answer summary: Remove Answer operationId: FormsSubmissionsAnswer_removeById description: Delete a answer for a submission parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormsSubmissionsAnswerRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/FormsSubmissionsAnswerRemoveById404Response example: error: 'Not found: Record missing' /workspaces/{workspace_id}/form_submissions: get: tags: - FormSubmission summary: List Form Submissions operationId: FormSubmission_listSubmissions description: List Form Submissions parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FormSubmissionListSubmissionsResponse' example: - id: 2 public_id: WPIUYc contact_id: 63 workspace_id: 42 page_id: 9 created_at: null updated_at: null data: email: test@example.com phone: 123-456-7890 full_name: Test User t_shirt_size: L - id: 3 public_id: QemyCN contact_id: 64 workspace_id: 42 page_id: 10 created_at: null updated_at: null data: email: test@example.com phone: 123-456-7890 full_name: Test User t_shirt_size: L '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormSubmissionListSubmissions401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormSubmissionListSubmissions404Response' example: error: 'Not found: Record missing' /form_submissions/{id}: get: tags: - FormSubmission summary: Fetch Form Submission operationId: FormSubmission_getSubmission description: Fetch Form Submission parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormSubmissionAttributes' example: id: 4 public_id: ESVogu contact_id: 65 workspace_id: 42 page_id: 11 created_at: null updated_at: null data: email: test@example.com phone: 123-456-7890 full_name: Test User t_shirt_size: L '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FormSubmissionGetSubmissionResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FormSubmissionGetSubmission404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/fulfillments: get: tags: - Fulfillment summary: List Fulfillments operationId: Fulfillment_list description: List Fulfillments parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FulfillmentListResponse' example: - id: 2 public_id: GsaZFM workspace_id: 42 contact_id: 72 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 3 fulfillment_number: 2 created_at: '2024-03-15T15:33:58.321Z' updated_at: '2024-03-15T15:33:58.321Z' included_invoices_line_items: - id: 2 public_id: eDqWnw fulfillment_id: 2 quantity: 1 invoices_line_item_id: 7 - id: 3 public_id: OGiBQU workspace_id: 42 contact_id: 74 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 4 fulfillment_number: 3 created_at: '2024-03-15T15:33:58.969Z' updated_at: '2024-03-15T15:33:58.969Z' included_invoices_line_items: - id: 3 public_id: grsMPk fulfillment_id: 3 quantity: 1 invoices_line_item_id: 9 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentList404Response' example: error: 'Not found: Record missing' post: tags: - Fulfillment summary: Create Fulfillment operationId: Fulfillment_create description: Create Fulfillment parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Fulfillment required: true content: application/json: schema: $ref: '#/components/schemas/FulfillmentCreateRequest' example: fulfillment: contact_id: 80 tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 7 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FulfillmentAttributes' example: id: 5 public_id: hCuoFq workspace_id: 42 contact_id: 78 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 6 fulfillment_number: 5 created_at: '2024-03-15T15:34:00.422Z' updated_at: '2024-03-15T15:34:00.422Z' included_invoices_line_items: - id: 5 public_id: uecgHT fulfillment_id: 5 quantity: 1 invoices_line_item_id: 13 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FulfillmentCreateResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentCreate401Response' example: error: API key missing or invalid /fulfillments/{id}: get: tags: - Fulfillment summary: Fetch Fulfillment operationId: Fulfillment_getById description: Fetch Fulfillment parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FulfillmentAttributes' example: id: 4 public_id: pJPgtG workspace_id: 42 contact_id: 76 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 5 fulfillment_number: 4 created_at: '2024-03-15T15:33:59.709Z' updated_at: '2024-03-15T15:33:59.709Z' included_invoices_line_items: - id: 4 public_id: itUpIe fulfillment_id: 4 quantity: 1 invoices_line_item_id: 11 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentGetById404Response' example: error: 'Not found: Record missing' put: tags: - Fulfillment summary: Update Fulfillment operationId: Fulfillment_updateById description: Update Fulfillment parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Fulfillment required: true content: application/json: schema: $ref: '#/components/schemas/FulfillmentUpdateByIdRequest' example: fulfillment: contact_id: 84 tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 9 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FulfillmentAttributes' example: id: 7 public_id: oNVsJz workspace_id: 42 contact_id: 82 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 8 fulfillment_number: 7 created_at: '2024-03-15T15:34:01.857Z' updated_at: '2024-03-15T15:34:01.857Z' included_invoices_line_items: - id: 7 public_id: hteuSr fulfillment_id: 7 quantity: 1 invoices_line_item_id: 17 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FulfillmentUpdateByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentUpdateById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentUpdateById404Response' example: error: 'Not found: Record missing' /fulfillments/{id}/cancel: post: tags: - Fulfillment summary: Cancel a Fulfillment operationId: Fulfillment_cancelFulfillment description: >- This will cancel a Fulfillment. A Fulfillment can only be cancelled when it's in a "fulfilled" state. The "cancelled" state is final. parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FulfillmentAttributes' example: id: 3 public_id: AQaCpl workspace_id: 42 contact_id: 64 status: cancelled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 3 fulfillment_number: 3 created_at: '2024-01-22T18:28:57.577Z' updated_at: '2024-01-22T18:28:57.577Z' included_invoices_line_items: - id: 3 public_id: YxpuUw quantity: 1 invoices_line_item_id: 9 '404': description: Not Found '409': description: Conflict - occurs if product is already cancelled. '422': description: Unprocessable Entity /workspaces/{workspace_id}/fulfillments/locations: get: tags: - Fulfillments::Location summary: List Locations operationId: FulfillmentsLocation_list description: List Locations parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationListResponse' example: - id: 12 public_id: BRXNKY workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' - id: 13 public_id: QuXcFj workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationList404Response' example: error: 'Not found: Record missing' post: tags: - Fulfillments::Location summary: Create Location operationId: FulfillmentsLocation_createNewLocation description: Create Location parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Location required: true content: application/json: schema: $ref: >- #/components/schemas/FulfillmentsLocationCreateNewLocationRequest example: fulfillments_location: name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 archived: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationAttributes' example: id: 15 public_id: FxUdte workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/FulfillmentsLocationCreateNewLocationResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/FulfillmentsLocationCreateNewLocation401Response example: error: API key missing or invalid /fulfillments/locations/{id}: get: tags: - Fulfillments::Location summary: Fetch Location operationId: FulfillmentsLocation_getById description: Fetch Location parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationAttributes' example: id: 14 public_id: cNnqlp workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationGetById404Response' example: error: 'Not found: Record missing' put: tags: - Fulfillments::Location summary: Update Location operationId: FulfillmentsLocation_updateById description: Update Location parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Location required: true content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationUpdateByIdRequest' example: fulfillments_location: name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 archived: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationAttributes' example: id: 17 public_id: Xmnigj workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195244@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationUpdateByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationUpdateById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationUpdateById404Response' example: error: 'Not found: Record missing' delete: tags: - Fulfillments::Location summary: Remove Location operationId: FulfillmentsLocation_removeById description: Remove Location parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/FulfillmentsLocationRemoveById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/images: get: tags: - Image summary: List Images operationId: Image_list description: List Images parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ImageListResponse' example: - id: 62 public_id: CELaBS url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:34:04.969Z' updated_at: '2024-03-15T15:34:04.969Z' - id: 63 public_id: zrhJUt url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:34:04.975Z' updated_at: '2024-03-15T15:34:04.975Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ImageList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ImageList404Response' example: error: 'Not found: Record missing' post: tags: - Image summary: Create Image operationId: Image_create description: Create Image parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Image required: true content: application/json: schema: $ref: '#/components/schemas/ImageCreateRequest' example: image: alt_text: Alt text of the image name: Amazing Shot responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 65 public_id: KwIrZt url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:34:05.007Z' updated_at: '2024-03-15T15:34:05.007Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ImageCreateResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ImageCreate401Response' example: error: API key missing or invalid /images/{id}: get: tags: - Image summary: Fetch Image operationId: Image_getById description: Fetch Image parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 64 public_id: cZvhnX url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:34:04.993Z' updated_at: '2024-03-15T15:34:04.993Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ImageGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ImageGetById404Response' example: error: 'Not found: Record missing' put: tags: - Image summary: Update Image operationId: Image_updateById description: Update Image parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Image required: true content: application/json: schema: $ref: '#/components/schemas/ImageUpdateByIdRequest' example: image: alt_text: Alt text of the image name: Amazing Shot responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageAttributes' example: id: 67 public_id: dSUTWy url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:34:05.034Z' updated_at: '2024-03-15T15:34:05.034Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ImageUpdateByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ImageUpdateById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ImageUpdateById404Response' example: error: 'Not found: Record missing' delete: tags: - Image summary: Remove Image operationId: Image_removeById description: Remove Image parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ImageRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ImageRemoveById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/orders: get: tags: - Order summary: List Orders operationId: Order_listOrders description: List all orders for the current workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - description: >- Filtering - Keep in mind that depending on the tools that you use, you might run into different situations where additional encoding is needed. For example: - You might need to encode `filter[id]=1` as `filter%5Bid%5D=1` or use special options in your tools of choice to do it for you (like `g` in CURL). - Special URL characters like `%`, `+`, or unicode characters in emails (like Chinese characters) will need additional encoding. name: filter in: query required: false schema: type: object properties: contact_id: description: A comma-separated list of Contact IDs to filter by. type: string example: 142 id: description: A comma-separated list of Order IDs to filter by. type: string example: 142 style: deepObject explode: true responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrderListOrdersResponse' example: - id: 17 public_id: mHsxyn order_number: '277741' workspace_id: 42 contact_id: 90 total_amount: '123.00' currency: USD origination_channel_id: 23 origination_channel_type: User shipping_address_first_name: Ira shipping_address_last_name: Bechtelar shipping_address_organization_name: Testing, Inc. shipping_address_phone_number: '+19053871234' shipping_address_street_one: 29621 Emery Grove shipping_address_street_two: Suite 202 shipping_address_city: Johnsborough shipping_address_region: WA shipping_address_country: US shipping_address_postal_code: '40073' billing_address_street_one: 517 Roxanne Square billing_address_street_two: Suite 287 billing_address_city: Schoentown billing_address_region: WA billing_address_country: US billing_address_postal_code: 86001-6213 page_id: 27 notes: Asperiores officiis inventore aliquam. in_trial: false billing_status: pending service_status: pending order_type: one-time-order next_charge_at: null tax_amount: '0.00' trial_end_at: null billing_payment_method_id: null funnel_name: null tag_ids: - 19 discount_ids: [] activated_at: null workspace_sharing_id: null canceled_at: null canceled_by: null cancel_reason: null cancel_description: null churned_at: null created_at: '2024-03-15T15:34:05.487Z' updated_at: '2024-03-15T15:34:05.487Z' phone_number: 1-501-393-9125 page_name: Example Page origination_channel_name: '' order_page: id: 27 public_id: BTxioH name: Example Page contact: tags: - id: 110 public_id: LETohV name: Example Tag color: '#c882c8' id: 90 public_id: iHYWNL workspace_id: 42 anonymous: null email_address: test-04dbfe2e5fac66d09840@example.com first_name: Douglas last_name: Gottlieb phone_number: 1-501-393-9125 time_zone: Pacific Time (US & Canada) uuid: a79fb9ba-6d67-4ed6-b7cb-fbd79c10bfcc unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:34:05.121Z' updated_at: '2024-03-15T15:34:05.121Z' contact_groups: - id: 17 public_id: XITAld name: Example Group workspace: id: 42 public_id: reAWDT team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:34:05.099Z' updated_at: '2024-03-15T15:34:05.099Z' segments: - id: 17 public_id: bIlPay name: Example Segment line_items: - id: 17 public_id: QNOXex order_id: 17 quantity: 1 prorated: null created_at: '2024-02-17T13:33:28.947Z' updated_at: '2024-04-04T19:27:04.752Z' original_product: id: 6503 public_id: Ykznlj name: Cool Shirt products_price: id: 27 public_id: KNXRjo amount: '29.0' currency: usd duration: null interval: null interval_count: null products_variant: description: '' id: 11 public_id: OjzDND name: Cool Shirt sku: sku_5487923746 - id: 18 public_id: eiMnrk order_id: 17 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 61 public_id: cCGyeu name: Lightweight Copper Table d3b67d products_price: id: 42 public_id: KQXMxm amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Suscipit animi est est. id: 43 public_id: OWHdAm name: Intelligent Concrete Coat variant 62f0 sku: dHYx71YbKe8YjQWY previous_line_item: null - id: 18 public_id: DWMtkw order_number: '774460' workspace_id: 42 contact_id: 91 total_amount: '123.00' currency: USD origination_channel_id: 24 origination_channel_type: User shipping_address_first_name: Devon shipping_address_last_name: Rau shipping_address_organization_name: Testing, Inc. shipping_address_phone_number: '+19053871234' shipping_address_street_one: 13904 Reilly Valleys shipping_address_street_two: Suite 648 shipping_address_city: Dominicaside shipping_address_region: WA shipping_address_country: US shipping_address_postal_code: '93137' billing_address_street_one: 1096 Corkery Extension billing_address_street_two: Apt. 324 billing_address_city: Port Chelsea billing_address_region: WA billing_address_country: US billing_address_postal_code: '64001' page_id: 28 notes: Sint eum iusto harum. in_trial: false billing_status: pending service_status: pending order_type: one-time-order next_charge_at: null tax_amount: '0.00' trial_end_at: null billing_payment_method_id: null funnel_name: null tag_ids: - 20 discount_ids: [] activated_at: null workspace_sharing_id: null canceled_at: null canceled_by: null cancel_reason: null cancel_description: null churned_at: null created_at: '2024-03-15T15:34:05.970Z' updated_at: '2024-03-15T15:34:05.970Z' phone_number: (297) 116-2352 x8363 page_name: Example Page origination_channel_name: '' order_page: id: 28 public_id: WAJakf name: Example Page contact: tags: - id: 111 public_id: kVNoyI name: Example Tag color: '#305f2e' id: 91 public_id: CmzIEp workspace_id: 42 anonymous: null email_address: test-7bc336c957b17521f1f0@example.com first_name: Beatrice last_name: Strosin phone_number: (297) 116-2352 x8363 time_zone: Pacific Time (US & Canada) uuid: 3cc86db5-0fc3-4c40-8be5-ab2c1f2d43bf unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:34:05.603Z' updated_at: '2024-03-15T15:34:05.603Z' contact_groups: - id: 18 public_id: jsCXqv name: Example Group workspace: id: 42 public_id: nxQBEY team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:34:05.585Z' updated_at: '2024-03-15T15:34:05.585Z' segments: - id: 18 public_id: KhfUAQ name: Example Segment line_items: - id: 18 public_id: weGYJb order_id: 18 quantity: 2 prorated: null created_at: '2024-02-13T12:57:49.455Z' updated_at: '2024-04-04T19:27:04.936Z' original_product: id: 6503 public_id: Ykznlj name: Cool Shirt products_price: id: 27 public_id: KNXRjo amount: '29.0' currency: usd duration: null interval: null interval_count: null products_variant: description: '' id: 11 public_id: OjzDND name: Cool Shirt sku: sku_5487923746 - id: 19 public_id: DkoWYf order_id: 18 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 63 public_id: jbCEZM name: Aerodynamic Aluminum Table ae6cbb products_price: id: 43 public_id: XoGvQP amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Quos at fugiat enim. id: 44 public_id: CtvgLA name: Enormous Cotton Gloves variant 2a9a sku: z0DMs6wjnbSoQ8UH previous_line_item: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrderListOrders401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrderListOrders404Response' example: error: 'Not found: Record missing' /orders/{id}: get: tags: - Order summary: Fetch Order operationId: Order_getSingle description: Retrieve a specific order in the current workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderAttributes' example: id: 19 public_id: nHGxcS order_number: '965718' workspace_id: 42 contact_id: 92 total_amount: '123.00' currency: USD origination_channel_id: 25 origination_channel_type: User shipping_address_first_name: Francisco shipping_address_last_name: Kuhlman shipping_address_organization_name: Testing, Inc. shipping_address_phone_number: '+19053871234' shipping_address_street_one: 3301 Crona Shoal shipping_address_street_two: Suite 324 shipping_address_city: Eliciatown shipping_address_region: WA shipping_address_country: US shipping_address_postal_code: '29199' billing_address_street_one: 6879 Zieme Garden billing_address_street_two: Apt. 288 billing_address_city: Port Niki billing_address_region: WA billing_address_country: US billing_address_postal_code: '93131' page_id: 29 notes: Animi esse praesentium in. in_trial: false billing_status: pending service_status: pending order_type: one-time-order next_charge_at: null tax_amount: '0.00' trial_end_at: null billing_payment_method_id: null funnel_name: null tag_ids: - 21 discount_ids: [] activated_at: null workspace_sharing_id: null canceled_at: null canceled_by: null cancel_reason: null cancel_description: null churned_at: null created_at: '2024-03-15T15:34:06.564Z' updated_at: '2024-03-15T15:34:06.564Z' phone_number: (548) 246-1046 x703 page_name: Example Page origination_channel_name: '' order_page: id: 29 public_id: mNigeT name: Example Page contact: tags: - id: 112 public_id: JdkzyY name: Example Tag color: '#ec65bd' id: 92 public_id: dgjmKu workspace_id: 42 anonymous: null email_address: test-b984bdf29903ac7d9705@example.com first_name: Trudy last_name: Quitzon phone_number: (548) 246-1046 x703 time_zone: Pacific Time (US & Canada) uuid: 28ebddef-f5da-4b04-9085-a04f9a6813c3 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:34:06.201Z' updated_at: '2024-03-15T15:34:06.201Z' contact_groups: - id: 19 public_id: SudebN name: Example Group workspace: id: 42 public_id: XTlCSL team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:34:06.179Z' updated_at: '2024-03-15T15:34:06.179Z' segments: - id: 19 public_id: nHTQvI name: Example Segment line_items: - id: 19 public_id: ojwkjO order_id: 19 quantity: 7 prorated: null created_at: '2024-02-12T15:07:14.533Z' updated_at: '2024-04-04T19:27:05.154Z' original_product: id: 6503 public_id: Ykznlj name: Cool Shirt products_price: id: 27 public_id: KNXRjo amount: '29.0' currency: usd duration: null interval: null interval_count: null products_variant: description: '' id: 11 public_id: OjzDND name: Cool Shirt sku: sku_5487923746 - id: 20 public_id: vTYSxZ order_id: 19 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 65 public_id: PFMUoA name: Lightweight Copper Chair db4687 products_price: id: 44 public_id: BrKUTN amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Fugit et accusamus animi. id: 45 public_id: IlkFJy name: Synergistic Wool Keyboard variant 8d95 sku: uqicmbGE4dZBDzFg previous_line_item: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrderGetSingleResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrderGetSingle404Response' example: error: 'Not found: Record missing' put: tags: - Order summary: Update Order operationId: Order_updateSpecific description: Update a specific order in the current workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Order required: true content: application/json: schema: $ref: '#/components/schemas/OrderUpdateSpecificRequest' example: order: notes: Ut voluptates commodi tempora. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderAttributes' example: id: 22 public_id: oGkyiZ order_number: '668124' workspace_id: 42 contact_id: 95 total_amount: '123.00' currency: USD origination_channel_id: 28 origination_channel_type: User shipping_address_first_name: Elden shipping_address_last_name: Harvey shipping_address_organization_name: Testing, Inc. shipping_address_phone_number: '+19053871234' shipping_address_street_one: 52563 Mui Shores shipping_address_street_two: Suite 815 shipping_address_city: North Tommy shipping_address_region: WA shipping_address_country: US shipping_address_postal_code: '93458' billing_address_street_one: 610 Baumbach Lakes billing_address_street_two: Suite 553 billing_address_city: New Reedbury billing_address_region: WA billing_address_country: US billing_address_postal_code: '07393' page_id: 32 notes: Maiores commodi et ut. in_trial: false billing_status: pending service_status: pending order_type: one-time-order next_charge_at: null tax_amount: '0.00' trial_end_at: null billing_payment_method_id: null funnel_name: null tag_ids: - 24 discount_ids: [] activated_at: null workspace_sharing_id: null canceled_at: null canceled_by: null cancel_reason: null cancel_description: null churned_at: null created_at: '2024-03-15T15:34:08.191Z' updated_at: '2024-03-15T15:34:08.191Z' phone_number: 727.169.7774 page_name: Example Page origination_channel_name: '' order_page: id: 32 public_id: PEOCWJ name: Example Page contact: tags: - id: 115 public_id: dWIwnS name: Example Tag color: '#1d5869' id: 95 public_id: yjOMGT workspace_id: 42 anonymous: null email_address: test-bafd108102a35dd48a30@example.com first_name: Genie last_name: Lindgren phone_number: 727.169.7774 time_zone: Pacific Time (US & Canada) uuid: 67602d97-09a0-4605-9625-74a3a5dd08d4 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:34:07.824Z' updated_at: '2024-03-15T15:34:07.825Z' contact_groups: - id: 22 public_id: ZeipFQ name: Example Group workspace: id: 42 public_id: qUikZy team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:34:07.804Z' updated_at: '2024-03-15T15:34:07.804Z' segments: - id: 22 public_id: rfwXQA name: Example Segment line_items: - id: 22 public_id: OJypjv order_id: 22 quantity: 3 prorated: null created_at: '2024-02-12T15:06:26.413Z' updated_at: '2024-04-04T19:27:05.757Z' original_product: id: 6503 public_id: Ykznlj name: Cool Shirt products_price: id: 27 public_id: KNXRjo amount: '29.0' currency: usd duration: null interval: null interval_count: null products_variant: description: '' id: 11 public_id: OjzDND name: Cool Shirt sku: sku_5487923746 - id: 23 public_id: pcrLBa order_id: 22 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 71 public_id: AQtLXp name: Incredible Rubber Bench e98e62 products_price: id: 47 public_id: IVJKaU amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Sint et eius dolorem. id: 48 public_id: iqpUxt name: Practical Marble Bag variant 2408 sku: uDytO9fK7LHkJ8Y2 previous_line_item: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/OrderUpdateSpecificResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrderUpdateSpecific401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrderUpdateSpecific404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/orders/invoices/restocks: get: tags: - Orders::Invoices::Restock summary: List Restocks operationId: OrdersInvoicesRestock_listRestocks description: List Restocks parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrdersInvoicesRestockListRestocksResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/OrdersInvoicesRestockListRestocks401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/OrdersInvoicesRestockListRestocks404Response example: error: 'Not found: Record missing' /orders/invoices/restocks/{id}: get: tags: - Orders::Invoices::Restock summary: Fetch Restock operationId: OrdersInvoicesRestock_getRestock description: Fetch Restock parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersInvoicesRestockGetRestockResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/OrdersInvoicesRestockGetRestock401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/OrdersInvoicesRestockGetRestock404Response example: error: 'Not found: Record missing' /orders/{order_id}/applied_tags: get: tags: - Orders::AppliedTag summary: List Applied Tags operationId: OrdersAppliedTag_list description: List the applied tags for an order parameters: - name: order_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagListResponse' example: - id: 2 public_id: OByQpm order_id: 26 tag_id: 29 created_at: '2024-04-15T15:34:10.657Z' updated_at: '2024-04-15T15:34:10.657Z' - id: 3 public_id: jXCotq order_id: 27 tag_id: 31 created_at: '2024-04-15T15:34:11.184Z' updated_at: '2024-04-15T15:34:11.184Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagList404Response' example: error: 'Not found: Record missing' post: tags: - Orders::AppliedTag summary: Create Applied Tag operationId: OrdersAppliedTag_createAppliedTag description: Assign a tag to an order by creating an applied tag parameters: - name: order_id in: path required: true schema: type: integer requestBody: description: Information about a new Applied Tag required: true content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagCreateAppliedTagRequest' example: orders_applied_tag: tag_id: 37 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagAttributes' example: id: 5 public_id: GPfuHJ order_id: 29 tag_id: 35 created_at: '2024-04-15T15:34:12.256Z' updated_at: '2024-04-15T15:34:12.256Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagCreateAppliedTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/OrdersAppliedTagCreateAppliedTag401Response example: error: API key missing or invalid /orders/applied_tags/{id}: get: tags: - Orders::AppliedTag summary: Fetch Applied Tag operationId: OrdersAppliedTag_get description: Retrieve an applied tag for an order parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagAttributes' example: id: 4 public_id: OshFgS order_id: 28 tag_id: 33 created_at: '2024-04-15T15:34:11.738Z' updated_at: '2024-04-15T15:34:11.738Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagGetResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagGet404Response' example: error: 'Not found: Record missing' delete: tags: - Orders::AppliedTag summary: Remove Applied Tag operationId: OrdersAppliedTag_removeById description: Remove a tag from an order by deleting an applied tag parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersAppliedTagRemoveById404Response' example: error: 'Not found: Record missing' /orders/{order_id}/invoices: get: tags: - Orders::Invoice summary: List Invoices operationId: OrdersInvoice_listForOrder description: List invoices for an order parameters: - name: order_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceListForOrderResponse' example: - id: 13 public_id: zNgmdQ order_id: 35 status: paid due_amount: '0.00' total_amount: '9.99' subtotal_amount: '9.99' tax_amount: '9.99' shipping_amount: '9.99' discount_amount: '9.99' currency: USD issued_at: '2024-03-15T15:34:15.000Z' due_at: '2024-04-22T15:34:15.000Z' paid_at: '2024-04-08T15:34:15.000Z' invoice_type: null invoice_number: '99' created_at: '2024-03-15T15:34:15.568Z' updated_at: '2024-03-15T15:34:15.568Z' line_items: - description: Example Description id: 24 public_id: oIYHXa invoice_id: 13 external_id: Example External ID payment_type: one_time amount: '9.99' quantity: 1 fulfillment_status: unfulfilled external_product_id: Example External Product ID discount_amount: '9.99' state_tax_amount: '3.33' county_tax_amount: '3.33' city_tax_amount: '2.22' district_tax_amount: '1.11' state_tax_rate: '0.3' county_tax_rate: '0.3' city_tax_rate: '0.2' district_tax_rate: '0.1' country_tax_jurisdiction: Example Country Tax Jurisdiction state_tax_jurisdiction: Example State Tax Jurisdiction county_tax_jurisdiction: Example County Tax Jurisdiction city_tax_jurisdiction: Example City Tax Jurisdiction period_start_at: null period_end_at: null period_number: null created_at: null updated_at: null products_price: id: 61 public_id: ztlRQM amount: '100.0' currency: USD duration: 1 interval: months interval_count: 1 products_variant: description: Maxime eum sunt explicabo. id: 62 public_id: qeJPpy product_id: 99 name: Lightweight Cotton Watch variant 8672 sku: WXVRXPUB22LZQI3X fulfillment_required: false - id: 14 public_id: MynZJH order_id: 36 status: paid due_amount: '0.00' total_amount: '9.99' subtotal_amount: '9.99' tax_amount: '9.99' shipping_amount: '9.99' discount_amount: '9.99' currency: USD issued_at: '2024-03-15T15:34:16.000Z' due_at: '2024-04-22T15:34:16.000Z' paid_at: '2024-04-08T15:34:16.000Z' invoice_type: null invoice_number: '99' created_at: '2024-03-15T15:34:16.116Z' updated_at: '2024-03-15T15:34:16.116Z' line_items: - description: Example Description id: 25 public_id: nvkdjD invoice_id: 14 external_id: Example External ID payment_type: one_time amount: '9.99' quantity: 1 fulfillment_status: unfulfilled external_product_id: Example External Product ID discount_amount: '9.99' state_tax_amount: '3.33' county_tax_amount: '3.33' city_tax_amount: '2.22' district_tax_amount: '1.11' state_tax_rate: '0.3' county_tax_rate: '0.3' city_tax_rate: '0.2' district_tax_rate: '0.1' country_tax_jurisdiction: Example Country Tax Jurisdiction state_tax_jurisdiction: Example State Tax Jurisdiction county_tax_jurisdiction: Example County Tax Jurisdiction city_tax_jurisdiction: Example City Tax Jurisdiction period_start_at: null period_end_at: null period_number: null created_at: null updated_at: null products_price: id: 63 public_id: bpPmCX amount: '100.0' currency: USD duration: 1 interval: months interval_count: 1 products_variant: description: Vel asperiores facilis neque. id: 64 public_id: kmPSio product_id: 102 name: Incredible Plastic Table variant 2eb4 sku: zkV13RojQBRKTdbu fulfillment_required: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceListForOrder401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceListForOrder404Response' example: error: 'Not found: Record missing' /orders/invoices/{id}: get: tags: - Orders::Invoice summary: Fetch Invoice operationId: OrdersInvoice_getForOrder description: Retrieve an invoice for an order parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceAttributes' example: id: 15 public_id: rbezHG order_id: 37 status: paid due_amount: '0.00' total_amount: '9.99' subtotal_amount: '9.99' tax_amount: '9.99' shipping_amount: '9.99' discount_amount: '9.99' currency: USD issued_at: '2024-03-15T15:34:16.000Z' due_at: '2024-04-22T15:34:16.000Z' paid_at: '2024-04-08T15:34:16.000Z' invoice_type: null invoice_number: '99' created_at: '2024-03-15T15:34:16.770Z' updated_at: '2024-03-15T15:34:16.770Z' line_items: - description: Example Description id: 26 public_id: aQvWNd invoice_id: 15 external_id: Example External ID payment_type: one_time amount: '9.99' quantity: 1 fulfillment_status: unfulfilled external_product_id: Example External Product ID discount_amount: '9.99' state_tax_amount: '3.33' county_tax_amount: '3.33' city_tax_amount: '2.22' district_tax_amount: '1.11' state_tax_rate: '0.3' county_tax_rate: '0.3' city_tax_rate: '0.2' district_tax_rate: '0.1' country_tax_jurisdiction: Example Country Tax Jurisdiction state_tax_jurisdiction: Example State Tax Jurisdiction county_tax_jurisdiction: Example County Tax Jurisdiction city_tax_jurisdiction: Example City Tax Jurisdiction period_start_at: null period_end_at: null period_number: null created_at: null updated_at: null products_price: id: 65 public_id: EMGbws amount: '100.0' currency: USD duration: 1 interval: months interval_count: 1 products_variant: description: Error aut quasi a. id: 66 public_id: vAZdoE product_id: 105 name: Ergonomic Granite Bottle variant 83ef sku: MZ3FmoBh8qYPDJCo fulfillment_required: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceGetForOrderResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersInvoiceGetForOrder404Response' example: error: 'Not found: Record missing' /orders/{order_id}/transactions: get: tags: - Orders::Transaction summary: List Transactions operationId: OrdersTransaction_getList description: List transactions for an order parameters: - name: order_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionGetListResponse' example: - id: 2 public_id: LYfsIS order_id: 44 status: completed external_type: sale external_id: 137c39d54e6969e56831aaba67801c12 amount: '100.00' currency: USD reason: null adjusted_transaction_id: null result: approved billing_payment_instruction_id: null billing_payment_instruction_type: null arn: null is_rebill: false rebill_number: null created_at: null updated_at: null - id: 3 public_id: gZCSWR order_id: 45 status: completed external_type: sale external_id: 0d21a490c7156e892079d8953421c452 amount: '100.00' currency: USD reason: null adjusted_transaction_id: null result: approved billing_payment_instruction_id: null billing_payment_instruction_type: null arn: null is_rebill: false rebill_number: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionGetList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionGetList404Response' example: error: 'Not found: Record missing' /orders/transactions/{id}: get: tags: - Orders::Transaction summary: Fetch Transaction operationId: OrdersTransaction_getById description: Retrieve a transaction for an order parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionAttributes' example: id: 4 public_id: UjRqPf order_id: 46 status: completed external_type: sale external_id: f8aa74625d5d1224a5db521eff275148 amount: '100.00' currency: USD reason: null adjusted_transaction_id: null result: approved billing_payment_instruction_id: null billing_payment_instruction_type: null arn: null is_rebill: false rebill_number: null created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionGetByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersTransactionGetById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/orders/tags: get: tags: - Orders::Tag summary: List Tags operationId: OrdersTag_list description: List all order tags for your workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/OrdersTagListResponse' example: - id: 64 public_id: hAVIlG workspace_id: 42 name: Example Tag color: '#42a349' created_at: '2024-04-15T15:34:25.065Z' updated_at: '2024-04-15T15:34:25.065Z' - id: 65 public_id: fpDuwk workspace_id: 42 name: Example Tag color: '#47da8c' created_at: '2024-04-15T15:34:25.073Z' updated_at: '2024-04-15T15:34:25.073Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTagList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersTagList404Response' example: error: 'Not found: Record missing' post: tags: - Orders::Tag summary: Create Tag operationId: OrdersTag_createNewTag description: Add a new order tag to your workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Tag required: true content: application/json: schema: $ref: '#/components/schemas/OrdersTagCreateNewTagRequest' example: orders_tag: name: Example Tag color: '#ac3dc8' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/OrdersTagAttributes' example: id: 67 public_id: SWdnwA workspace_id: 42 name: Example Tag color: '#b3eacf' created_at: '2024-04-15T15:34:25.105Z' updated_at: '2024-04-15T15:34:25.105Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/OrdersTagCreateNewTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTagCreateNewTag401Response' example: error: API key missing or invalid /orders/tags/{id}: get: tags: - Orders::Tag summary: Fetch Tag operationId: OrdersTag_getSingle description: Retrieve a single order tag parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersTagAttributes' example: id: 66 public_id: BPCvIu workspace_id: 42 name: Example Tag color: '#5465c7' created_at: '2024-04-15T15:34:25.091Z' updated_at: '2024-04-15T15:34:25.091Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTagGetSingleResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersTagGetSingle404Response' example: error: 'Not found: Record missing' put: tags: - Orders::Tag summary: Update Tag operationId: OrdersTag_updateSpecificOrderTag description: Update an order tag parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Tag required: true content: application/json: schema: $ref: '#/components/schemas/OrdersTagUpdateSpecificOrderTagRequest' example: orders_tag: name: Example Tag color: '#c96d6a' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrdersTagAttributes' example: id: 69 public_id: PNhbna workspace_id: 42 name: Example Tag color: '#281342' created_at: '2024-04-15T15:34:25.129Z' updated_at: '2024-04-15T15:34:25.129Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/OrdersTagUpdateSpecificOrderTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/OrdersTagUpdateSpecificOrderTag401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/OrdersTagUpdateSpecificOrderTag404Response example: error: 'Not found: Record missing' delete: tags: - Orders::Tag summary: Remove Tag operationId: OrdersTag_remove description: Delete an order tag from your workspace parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/OrdersTagRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/OrdersTagRemove404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/products: get: tags: - Product summary: List Products operationId: Product_listForWorkspace description: >- List products for a workspace. All products are listed regardless of `archived` state. parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ProductListForWorkspaceResponse' example: - id: 143 public_id: scEXfT workspace_id: 42 name: Durable Silk Bench ca0fb4 current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Est saepe ex et. seo_description: Est assumenda id voluptatibus. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 143 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.261Z' updated_at: '2024-04-15T15:34:25.261Z' variant_properties: - id: 143 name: Color - id: 144 public_id: jzpetX workspace_id: 42 name: Heavy Duty Marble Lamp 5884f5 current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Rerum quis praesentium rerum. seo_description: Reprehenderit aperiam cupiditate iste. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 144 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.293Z' updated_at: '2024-04-15T15:34:25.293Z' variant_properties: - id: 144 name: Color '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductListForWorkspace401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductListForWorkspace404Response' example: error: 'Not found: Record missing' post: tags: - Product summary: Create Product operationId: Product_addNewToWorkspace description: Add a new product to a workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Product required: true content: application/json: schema: $ref: '#/components/schemas/ProductAddNewToWorkspaceRequest' example: product: name: Intelligent Aluminum Clock ffdf37 current_path: null visible_in_store: true visible_in_customer_center: true seo_title: Atque voluptas officiis accusamus. seo_description: Optio sed molestiae voluptas. seo_image_id: null commissionable: true image_ids: [] variant_ids: [] price_ids: [] redirect_funnel_id: null cancellation_funnel_url: null responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductAttributes' example: id: 146 public_id: VcjqUP workspace_id: 42 name: Rustic Rubber Table b0e95b current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Est est ullam velit. seo_description: Quo est veritatis vitae. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 146 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.413Z' updated_at: '2024-04-15T15:34:25.413Z' variant_properties: - id: 146 name: Color '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductAddNewToWorkspaceResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductAddNewToWorkspace401Response' example: error: API key missing or invalid /products/{id}: get: tags: - Product summary: Fetch Product operationId: Product_getForWorkspace description: Retrieve a product for a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductAttributes' example: id: 145 public_id: iwceUf workspace_id: 42 name: Intelligent Paper Coat a868c9 current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Consequatur ut soluta vel. seo_description: Sed aut necessitatibus aut. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 145 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.360Z' updated_at: '2024-04-15T15:34:25.360Z' variant_properties: - id: 145 name: Color '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductGetForWorkspaceResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductGetForWorkspace404Response' example: error: 'Not found: Record missing' put: tags: - Product summary: Update Product operationId: Product_updateForWorkspace description: Update a product for a workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Product required: true content: application/json: schema: $ref: '#/components/schemas/ProductUpdateForWorkspaceRequest' example: product: name: Sleek Marble Pants b78efc current_path: null visible_in_store: true visible_in_customer_center: true seo_title: Officia ut quibusdam itaque. seo_description: Quo similique quidem dolores. seo_image_id: null commissionable: true image_ids: [] variant_ids: [] price_ids: [] redirect_funnel_id: null cancellation_funnel_url: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductAttributes' example: id: 148 public_id: OneKtx workspace_id: 42 name: Mediocre Concrete Clock b3279a current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Sed suscipit pariatur sint. seo_description: Iusto doloribus praesentium tempore. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 148 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.535Z' updated_at: '2024-04-15T15:34:25.535Z' variant_properties: - id: 148 name: Color '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductUpdateForWorkspaceResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductUpdateForWorkspace401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductUpdateForWorkspace404Response' example: error: 'Not found: Record missing' /products/{id}/archive: post: tags: - Product summary: Archive a Product operationId: Product_archiveProduct description: >- This will archive a Product. A product can only be archived if it's not in the "live" state. parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductAttributes' example: id: 144 public_id: nQiXfU workspace_id: 42 name: Practical Marble Bottle d5cb42 current_path: null archived: true visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Ea facere incidunt eos. seo_description: Explicabo et minus repudiandae. seo_image_id: null commissionable: true image_ids: [] variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-02-23T09:57:23.643Z' updated_at: '2024-02-23T09:57:23.643Z' '404': description: Not Found '409': description: Conflict - occurs if product is already archived. '422': description: Unprocessable Entity /products/{id}/unarchive: post: tags: - Product summary: Unarchive a Product operationId: Product_unarchiveById description: This will unarchive a Product. parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductAttributes' example: id: 142 public_id: OaoMQH workspace_id: 42 name: Lightweight Copper Shirt de364e current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Similique aut tempore quam. seo_description: Quidem voluptates minima non. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 142 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:34:25.209Z' updated_at: '2024-04-15T15:34:25.209Z' variant_properties: - id: 142 name: Color '404': description: Not Found '409': description: Conflict - occurs if product is not archived. '422': description: Unprocessable Entity /products/variants/{variant_id}/prices: post: tags: - Products::Price summary: Create Price operationId: ProductsPrice_createNewPrice description: Create a new price for a given variant parameters: - name: variant_id in: path required: true schema: type: integer requestBody: description: Information about a new Price required: true content: application/json: schema: $ref: '#/components/schemas/ProductsPriceCreateNewPriceRequest' example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 90 public_id: geAIrG variant_id: 91 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-03-08T15:43:19.406Z' updated_at: '2024-03-08T15:43:19.406Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsPriceCreateNewPriceResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsPriceCreateNewPrice401Response' example: error: API key missing or invalid /products/{product_id}/prices: get: tags: - Products::Price summary: List Prices operationId: ProductsPrice_listForVariant description: List all prices for a given variant parameters: - name: product_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ProductsPriceListForVariantResponse' example: - id: 87 public_id: ZkWLRE variant_id: 88 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-04-15T15:34:25.797Z' updated_at: '2024-04-15T15:34:25.797Z' - id: 88 public_id: xgdYyG variant_id: 89 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-04-15T15:34:25.850Z' updated_at: '2024-04-15T15:34:25.850Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsPriceListForVariant401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsPriceListForVariant404Response' example: error: 'Not found: Record missing' /products/prices/{id}: get: tags: - Products::Price summary: Fetch Price operationId: ProductsPrice_getSinglePrice description: Retrieve a single price parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 89 public_id: zcUkaf variant_id: 90 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-04-15T15:34:25.923Z' updated_at: '2024-04-15T15:34:25.923Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsPriceGetSinglePriceResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsPriceGetSinglePrice404Response' example: error: 'Not found: Record missing' put: tags: - Products::Price summary: Update Price operationId: ProductsPrice_updateSinglePrice description: Update a single price parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Price required: true content: application/json: schema: $ref: '#/components/schemas/ProductsPriceUpdateSinglePriceRequest' example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 92 public_id: IvyLWp variant_id: 93 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-04-15T15:34:26.123Z' updated_at: '2024-04-15T15:34:26.123Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsPriceUpdateSinglePriceResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsPriceUpdateSinglePrice401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsPriceUpdateSinglePrice404Response' example: error: 'Not found: Record missing' /products/{product_id}/variants: get: tags: - Products::Variant summary: List Variants operationId: ProductsVariant_list description: List variants for a product parameters: - name: product_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ProductsVariantListResponse' example: - description: Sunt non eligendi tenetur. id: 97 public_id: oCesmv product_id: 161 name: Fantastic Leather Gloves variant 2685 sku: pkYvGTCKS7aD0sZr product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '32.0' weight_unit: lb height: '82.0' width: '812.0' length: '32.0' dimensions_unit: inches quantity: 0 tag_ids: - 259 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:34:26.429Z' updated_at: '2024-04-15T15:34:26.429Z' default: false properties_values: - property_id: 97 value: Ruby - description: Rem dolorum omnis ab. id: 98 public_id: iJKobD product_id: 162 name: Heavy Duty Cotton Pants variant 7f36 sku: Kh7mFO3bry8xt3vq product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '41.0' weight_unit: lb height: '84.0' width: '247.0' length: '42.0' dimensions_unit: inches quantity: 0 tag_ids: - 261 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:34:26.486Z' updated_at: '2024-04-15T15:34:26.486Z' default: false properties_values: - property_id: 98 value: Gray '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsVariantList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsVariantList404Response' example: error: 'Not found: Record missing' post: tags: - Products::Variant summary: Create Variant operationId: ProductsVariant_createNewVariant description: Create a new variant for a product parameters: - name: product_id in: path required: true schema: type: integer requestBody: description: Information about a new Variant required: true content: application/json: schema: $ref: '#/components/schemas/ProductsVariantCreateNewVariantRequest' example: products_variant: description: Soluta expedita veniam unde. name: Durable Leather Gloves variant cd44 sku: CfWfLHP2BRBhGjm3 product_type: physical out_of_stock_sales: null weight: '71.0' weight_unit: lb height: '88.0' width: '286.0' length: '58.0' dimensions_unit: inches tax_category_id: null taxable: null track_quantity: false archived: false visible: true fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductsVariantAttributes' example: description: Quam dolor nihil sunt. id: 100 public_id: NLFDde product_id: 164 name: Heavy Duty Plastic Car variant 3a0a sku: sY5FjY584NCkgAt0 product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '36.0' weight_unit: lb height: '26.0' width: '463.0' length: '40.0' dimensions_unit: inches quantity: 0 tag_ids: - 265 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:34:26.678Z' updated_at: '2024-04-15T15:34:26.678Z' default: false properties_values: - property_id: 100 value: Raspberry '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsVariantCreateNewVariantResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ProductsVariantCreateNewVariant401Response example: error: API key missing or invalid /products/variants/{id}: get: tags: - Products::Variant summary: Fetch Variant operationId: ProductsVariant_getSingle description: Retrieve a single variant parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsVariantAttributes' example: description: Ut facere sed dolore. id: 99 public_id: sDfkQu product_id: 163 name: Durable Cotton Knife variant afaa sku: DakTWNn6S5coBduX product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '24.0' weight_unit: lb height: '67.0' width: '459.0' length: '92.0' dimensions_unit: inches quantity: 0 tag_ids: - 263 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:34:26.595Z' updated_at: '2024-04-15T15:34:26.595Z' default: false properties_values: - property_id: 99 value: Scarlet '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsVariantGetSingleResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsVariantGetSingle404Response' example: error: 'Not found: Record missing' put: tags: - Products::Variant summary: Update Variant operationId: ProductsVariant_updateSingle description: Update a single variant parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Variant required: true content: application/json: schema: $ref: '#/components/schemas/ProductsVariantUpdateSingleRequest' example: products_variant: description: Assumenda sed impedit earum. name: Ergonomic Steel Gloves variant 8b5c sku: KXhRmEHodbzIF5cG product_type: physical out_of_stock_sales: null weight: '67.0' weight_unit: lb height: '51.0' width: '785.0' length: '20.0' dimensions_unit: inches tax_category_id: null taxable: null track_quantity: false archived: false visible: true fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsVariantAttributes' example: description: Nobis quisquam dolores nulla. id: 102 public_id: LOSyeP product_id: 166 name: Sleek Bronze Wallet variant e84d sku: Tkgyn3jLMuTpZw9M product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '92.0' weight_unit: lb height: '25.0' width: '612.0' length: '34.0' dimensions_unit: inches quantity: 0 tag_ids: - 269 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:34:26.859Z' updated_at: '2024-04-15T15:34:26.859Z' default: false properties_values: - property_id: 102 value: Lilac '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsVariantUpdateSingleResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsVariantUpdateSingle401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsVariantUpdateSingle404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/products/tags: get: tags: - Products::Tag summary: List Tags operationId: ProductsTag_list description: List tags for a product parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ProductsTagListResponse' example: - id: 276 public_id: wULCkd workspace_id: 42 name: Example Tag color: lilac created_at: '2024-04-15T15:34:27.151Z' updated_at: '2024-04-15T15:34:27.151Z' - id: 277 public_id: mhQAgi workspace_id: 42 name: Example Tag color: violet created_at: '2024-04-15T15:34:27.158Z' updated_at: '2024-04-15T15:34:27.158Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsTagList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsTagList404Response' example: error: 'Not found: Record missing' post: tags: - Products::Tag summary: Create Tag operationId: ProductsTag_createNewTag description: Add a new tag to a product parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Tag required: true content: application/json: schema: $ref: '#/components/schemas/ProductsTagCreateNewTagRequest' example: products_tag: name: Example Tag color: byzantium responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductsTagAttributes' example: id: 279 public_id: TxQvDR workspace_id: 42 name: Example Tag color: erin created_at: '2024-04-15T15:34:27.191Z' updated_at: '2024-04-15T15:34:27.191Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsTagCreateNewTagResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsTagCreateNewTag401Response' example: error: API key missing or invalid /products/tags/{id}: get: tags: - Products::Tag summary: Fetch Tag operationId: ProductsTag_getTagById description: Retrieve a tag for a product parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsTagAttributes' example: id: 278 public_id: BOJVHb workspace_id: 42 name: Example Tag color: periwinkle created_at: '2024-04-15T15:34:27.176Z' updated_at: '2024-04-15T15:34:27.176Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsTagGetTagByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsTagGetTagById404Response' example: error: 'Not found: Record missing' put: tags: - Products::Tag summary: Update Tag operationId: ProductsTag_updateTagById description: Update a tag for a product parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Tag required: true content: application/json: schema: $ref: '#/components/schemas/ProductsTagUpdateTagByIdRequest' example: products_tag: name: Example Tag color: erin responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsTagAttributes' example: id: 281 public_id: lMwXEK workspace_id: 42 name: Example Tag color: sky created_at: '2024-04-15T15:34:27.216Z' updated_at: '2024-04-15T15:34:27.216Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProductsTagUpdateTagByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsTagUpdateTagById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsTagUpdateTagById404Response' example: error: 'Not found: Record missing' delete: tags: - Products::Tag summary: Remove Tag operationId: ProductsTag_deleteTagById description: Delete a tag for a product parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProductsTagDeleteTagByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ProductsTagDeleteTagById404Response' example: error: 'Not found: Record missing' /shipping/profiles/{profile_id}/location_groups: get: tags: - Shipping::LocationGroup summary: List Location Groups operationId: ShippingLocationGroup_list description: List location groups for a profile parameters: - name: profile_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingLocationGroupListResponse' example: - id: 4 public_id: WQxEjh profile_id: 5 name: Example Location Group fulfillments_location_ids: [] created_at: '2024-04-15T15:34:27.272Z' updated_at: '2024-04-15T15:34:27.272Z' - id: 5 public_id: Kyogqj profile_id: 6 name: Example Location Group fulfillments_location_ids: [] created_at: '2024-04-15T15:34:27.281Z' updated_at: '2024-04-15T15:34:27.281Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingLocationGroupList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingLocationGroupList404Response' example: error: 'Not found: Record missing' /shipping/location_groups/{id}: get: tags: - Shipping::LocationGroup summary: Fetch Location Group operationId: ShippingLocationGroup_getProfileLocationGroup description: Retrieve a location group for a profile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingLocationGroupAttributes' example: id: 6 public_id: WFxXRP profile_id: 7 name: Example Location Group fulfillments_location_ids: [] created_at: '2024-04-15T15:34:27.304Z' updated_at: '2024-04-15T15:34:27.304Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingLocationGroupGetProfileLocationGroupResponse example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ShippingLocationGroupGetProfileLocationGroup404Response example: error: 'Not found: Record missing' /workspaces/{workspace_id}/shipping/packages: get: tags: - Shipping::Package summary: List Packages operationId: ShippingPackage_listForWorkspace description: List packages for a workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingPackageListForWorkspaceResponse' example: - id: 2 public_id: UVaJpt package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:34:27.412Z' updated_at: '2024-04-15T15:34:27.412Z' - id: 3 public_id: dMZoav package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:34:27.419Z' updated_at: '2024-04-15T15:34:27.419Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingPackageListForWorkspace401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ShippingPackageListForWorkspace404Response example: error: 'Not found: Record missing' post: tags: - Shipping::Package summary: Create Package operationId: ShippingPackage_addToWorkspace description: Add a new package to a workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Package required: true content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAddToWorkspaceRequest' example: shipping_package: package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package carrier: null responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAttributes' example: id: 5 public_id: cOHqzF package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:34:27.452Z' updated_at: '2024-04-15T15:34:27.452Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAddToWorkspaceResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAddToWorkspace401Response' example: error: API key missing or invalid /shipping/packages/{id}: get: tags: - Shipping::Package summary: Fetch Package operationId: ShippingPackage_getForWorkspace description: Retrieve a package for a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAttributes' example: id: 4 public_id: ZeDbRi package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:34:27.438Z' updated_at: '2024-04-15T15:34:27.438Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingPackageGetForWorkspaceResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingPackageGetForWorkspace404Response' example: error: 'Not found: Record missing' put: tags: - Shipping::Package summary: Update Package operationId: ShippingPackage_updateForWorkspace description: Update a package for a workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Package required: true content: application/json: schema: $ref: '#/components/schemas/ShippingPackageUpdateForWorkspaceRequest' example: shipping_package: package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package carrier: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingPackageAttributes' example: id: 7 public_id: IKafkO package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:34:27.478Z' updated_at: '2024-04-15T15:34:27.478Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingPackageUpdateForWorkspaceResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingPackageUpdateForWorkspace401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ShippingPackageUpdateForWorkspace404Response example: error: 'Not found: Record missing' delete: tags: - Shipping::Package summary: Remove Package operationId: ShippingPackage_removeById description: Delete a package for a workspace parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingPackageRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingPackageRemoveById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/shipping/profiles: get: tags: - Shipping::Profile summary: List Profiles operationId: ShippingProfile_list description: List shipping profiles for a workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingProfileListResponse' example: - id: 14 public_id: TQXAxN name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:34:27.541Z' updated_at: '2024-04-15T15:34:27.541Z' - id: 15 public_id: wdQrbI name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:34:27.548Z' updated_at: '2024-04-15T15:34:27.548Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingProfileList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingProfileList404Response' example: error: 'Not found: Record missing' post: tags: - Shipping::Profile summary: Create Profile operationId: ShippingProfile_createNew description: Add a new shipping profile to a workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Profile required: true content: application/json: schema: $ref: '#/components/schemas/ShippingProfileCreateNewRequest' example: shipping_profile: name: Example Shipping Profile variant_ids: [] responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ShippingProfileAttributes' example: id: 17 public_id: JWqghu name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:34:27.583Z' updated_at: '2024-04-15T15:34:27.583Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingProfileCreateNewResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingProfileCreateNew401Response' example: error: API key missing or invalid /shipping/profiles/{id}: get: tags: - Shipping::Profile summary: Fetch Profile operationId: ShippingProfile_getWorkspaceProfile description: Retrieve a shipping profile for a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingProfileAttributes' example: id: 16 public_id: xHKUQs name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:34:27.568Z' updated_at: '2024-04-15T15:34:27.568Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingProfileGetWorkspaceProfileResponse example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ShippingProfileGetWorkspaceProfile404Response example: error: 'Not found: Record missing' put: tags: - Shipping::Profile summary: Update Profile operationId: ShippingProfile_updateForWorkspace description: Update a shipping profile for a workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Profile required: true content: application/json: schema: $ref: '#/components/schemas/ShippingProfileUpdateForWorkspaceRequest' example: shipping_profile: name: Example Shipping Profile variant_ids: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingProfileAttributes' example: id: 19 public_id: SvZwTX name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:34:27.610Z' updated_at: '2024-04-15T15:34:27.610Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingProfileUpdateForWorkspaceResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingProfileUpdateForWorkspace401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/ShippingProfileUpdateForWorkspace404Response example: error: 'Not found: Record missing' delete: tags: - Shipping::Profile summary: Remove Profile operationId: ShippingProfile_remove description: Delete a shipping profile for a workspace parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingProfileRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingProfileRemove404Response' example: error: 'Not found: Record missing' /shipping/zones/{zone_id}/rates: get: tags: - Shipping::Rate summary: List Rates operationId: ShippingRate_listForZone description: List shipping rates for a zone parameters: - name: zone_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingRateListForZoneResponse' example: - description: Example Shipping Rates Name id: 2 public_id: aYAKxt zone_id: 3 provider_name: Grady Keebler price: '10.00' price_currency: USD rates_name_id: 3 live_rates_provider: null created_at: '2024-04-15T15:34:27.679Z' updated_at: '2024-04-15T15:34:27.679Z' - description: Example Shipping Rates Name id: 3 public_id: XaMoPG zone_id: 4 provider_name: Britta Wuckert DVM price: '10.00' price_currency: USD rates_name_id: 4 live_rates_provider: null created_at: '2024-04-15T15:34:27.690Z' updated_at: '2024-04-15T15:34:27.690Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRateListForZone401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRateListForZone404Response' example: error: 'Not found: Record missing' post: tags: - Shipping::Rate summary: Create Rate operationId: ShippingRate_createRateForZone description: Add a new shipping rate to a zone parameters: - name: zone_id in: path required: true schema: type: integer requestBody: description: Information about a new Rate required: true content: application/json: schema: $ref: '#/components/schemas/ShippingRateCreateRateForZoneRequest' example: shipping_rate: provider_name: Tianna Russel price: '10.00' price_currency: USD rates_name_id: 7 live_rates_provider: null responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ShippingRateAttributes' example: description: Example Shipping Rates Name id: 5 public_id: DWoyXf zone_id: 6 provider_name: Mr. Lyndon Hettinger price: '10.00' price_currency: USD rates_name_id: 6 live_rates_provider: null created_at: '2024-04-15T15:34:27.733Z' updated_at: '2024-04-15T15:34:27.733Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingRateCreateRateForZoneResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRateCreateRateForZone401Response' example: error: API key missing or invalid /shipping/rates/{id}: get: tags: - Shipping::Rate summary: Fetch Rate operationId: ShippingRate_getRateById description: Retrieve a shipping rate for a zone parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingRateAttributes' example: description: Example Shipping Rates Name id: 4 public_id: sruPfU zone_id: 5 provider_name: Demetria Baumbach DC price: '10.00' price_currency: USD rates_name_id: 5 live_rates_provider: null created_at: '2024-04-15T15:34:27.713Z' updated_at: '2024-04-15T15:34:27.713Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRateGetRateByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRateGetRateById404Response' example: error: 'Not found: Record missing' put: tags: - Shipping::Rate summary: Update Rate operationId: ShippingRate_updateRateForZone description: Update a shipping rate for a zone parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Rate required: true content: application/json: schema: $ref: '#/components/schemas/ShippingRateUpdateRateForZoneRequest' example: shipping_rate: provider_name: Prof. Matthew Kihn price: '10.00' price_currency: USD rates_name_id: 9 live_rates_provider: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingRateAttributes' example: description: Example Shipping Rates Name id: 7 public_id: gchXsw zone_id: 8 provider_name: Murray Lebsack DO price: '10.00' price_currency: USD rates_name_id: 8 live_rates_provider: null created_at: '2024-04-15T15:34:27.767Z' updated_at: '2024-04-15T15:34:27.767Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingRateUpdateRateForZoneResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRateUpdateRateForZone401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRateUpdateRateForZone404Response' example: error: 'Not found: Record missing' delete: tags: - Shipping::Rate summary: Remove Rate operationId: ShippingRate_removeById description: Delete a shipping rate for a zone parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRateRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRateRemoveById404Response' example: error: 'Not found: Record missing' /shipping/location_groups/{location_group_id}/zones: get: tags: - Shipping::Zone summary: List Zones operationId: ShippingZone_listZones description: List zones for a location group parameters: - name: location_group_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingZoneListZonesResponse' example: - id: 12 public_id: DKCxMp location_group_id: 22 name: Eusebio Collins address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:34:27.851Z' updated_at: null - id: 13 public_id: cvrCRl location_group_id: 23 name: Nicola VonRueden address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:34:27.858Z' updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingZoneListZones401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingZoneListZones404Response' example: error: 'Not found: Record missing' post: tags: - Shipping::Zone summary: Create Zone operationId: ShippingZone_addNewZone description: Add a new zone to a location group parameters: - name: location_group_id in: path required: true schema: type: integer requestBody: description: Information about a new Zone required: true content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAddNewZoneRequest' example: shipping_zone: name: Sen. Theressa Hettinger address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAttributes' example: id: 15 public_id: LrWnDh location_group_id: 25 name: Carrol Gerhold MD address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:34:27.904Z' updated_at: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAddNewZoneResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAddNewZone401Response' example: error: API key missing or invalid /shipping/zones/{id}: get: tags: - Shipping::Zone summary: Fetch Zone operationId: ShippingZone_getZoneById description: Retrieve a zone for a location group parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAttributes' example: id: 14 public_id: jRdvHQ location_group_id: 24 name: Rev. Sidney Kuphal address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:34:27.884Z' updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingZoneGetZoneByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingZoneGetZoneById404Response' example: error: 'Not found: Record missing' put: tags: - Shipping::Zone summary: Update Zone operationId: ShippingZone_updateZoneById description: Update a zone for a location group parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Zone required: true content: application/json: schema: $ref: '#/components/schemas/ShippingZoneUpdateZoneByIdRequest' example: shipping_zone: name: Gil Kassulke DVM address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingZoneAttributes' example: id: 17 public_id: haZScL location_group_id: 27 name: Angel Kuhic Jr. address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:34:27.939Z' updated_at: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingZoneUpdateZoneByIdResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingZoneUpdateZoneById401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingZoneUpdateZoneById404Response' example: error: 'Not found: Record missing' delete: tags: - Shipping::Zone summary: Remove Zone operationId: ShippingZone_removeById description: Delete a zone for a location group parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingZoneRemoveByIdResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingZoneRemoveById404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/shipping/rates/names: get: tags: - Shipping::Rates::Name summary: List Names operationId: ShippingRatesName_list description: List rate names for a shipping profile parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameListResponse' example: - id: 12 public_id: aJDbed workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:34:28.018Z' updated_at: '2024-04-15T15:34:28.018Z' - id: 13 public_id: XgjvZs workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:34:28.023Z' updated_at: '2024-04-15T15:34:28.023Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameList401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameList404Response' example: error: 'Not found: Record missing' post: tags: - Shipping::Rates::Name summary: Create Name operationId: ShippingRatesName_createNewRateName description: Add a new rate name to a shipping profile parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Name required: true content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameCreateNewRateNameRequest' example: shipping_rates_name: name: Example Shipping Rates Name responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameAttributes' example: id: 15 public_id: gxOzLp workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:34:28.053Z' updated_at: '2024-04-15T15:34:28.053Z' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/ShippingRatesNameCreateNewRateNameResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/ShippingRatesNameCreateNewRateName401Response example: error: API key missing or invalid /shipping/rates/names/{id}: get: tags: - Shipping::Rates::Name summary: Fetch Name operationId: ShippingRatesName_getRateName description: Retrieve a rate name for a shipping profile parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameAttributes' example: id: 14 public_id: hbvSmR workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:34:28.040Z' updated_at: '2024-04-15T15:34:28.040Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameGetRateNameResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameGetRateName404Response' example: error: 'Not found: Record missing' put: tags: - Shipping::Rates::Name summary: Update Name operationId: ShippingRatesName_updateName description: Update a rate name for a shipping profile parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Name required: true content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameUpdateNameRequest' example: shipping_rates_name: name: Example Shipping Rates Name responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameAttributes' example: id: 17 public_id: EThbOP workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:34:28.079Z' updated_at: '2024-04-15T15:34:28.079Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameUpdateNameResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameUpdateName401Response' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameUpdateName404Response' example: error: 'Not found: Record missing' delete: tags: - Shipping::Rates::Name summary: Remove Name operationId: ShippingRatesName_remove description: Delete a rate name for a shipping profile parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ShippingRatesNameRemove404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/webhooks/outgoing/endpoints: get: tags: - Webhooks::Outgoing::Endpoint summary: List Endpoints operationId: WebhooksOutgoingEndpoint_listEndpoints description: List webhook endpoints for a workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointListEndpointsResponse example: - id: 2 workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null - id: 3 workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointListEndpoints401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointListEndpoints404Response example: error: 'Not found: Record missing' post: tags: - Webhooks::Outgoing::Endpoint summary: Create Endpoint operationId: WebhooksOutgoingEndpoint_createNew description: Add a new webhook endpoint to a workspace parameters: - name: workspace_id in: path required: true schema: type: integer requestBody: description: Information about a new Endpoint required: true content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointCreateNewRequest' example: webhooks_outgoing_endpoint: url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointAttributes' example: id: 5 workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointCreateNewResponse' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointCreateNew401Response example: error: API key missing or invalid /webhooks/outgoing/endpoints/{id}: get: tags: - Webhooks::Outgoing::Endpoint summary: Fetch Endpoint operationId: WebhooksOutgoingEndpoint_get description: Retrieve a webhook endpoint for a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointAttributes' example: id: 4 workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointGetResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointGet404Response' example: error: 'Not found: Record missing' put: tags: - Webhooks::Outgoing::Endpoint summary: Update Endpoint operationId: WebhooksOutgoingEndpoint_updateEndpoint description: Update a webhook endpoint for a workspace parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Endpoint required: true content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointUpdateEndpointRequest example: webhooks_outgoing_endpoint: url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointAttributes' example: id: 7 workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointUpdateEndpointResponse '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointUpdateEndpoint401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEndpointUpdateEndpoint404Response example: error: 'Not found: Record missing' delete: tags: - Webhooks::Outgoing::Endpoint summary: Remove Endpoint operationId: WebhooksOutgoingEndpoint_remove description: Delete a webhook endpoint for a workspace parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointRemoveResponse' example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEndpointRemove404Response' example: error: 'Not found: Record missing' /workspaces/{workspace_id}/webhooks/outgoing/events: get: tags: - Webhooks::Outgoing::Event summary: List Events operationId: WebhooksOutgoingEvent_listForWorkspace description: List webhook events for a workspace parameters: - name: workspace_id in: path required: true schema: type: integer - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEventListForWorkspaceResponse example: - id: null public_id: LWqTli workspace_id: 42 uuid: 625fb05c3f9a69e57f50a4088a30a36f event_type_id: contact.identified subject_id: 126 subject_type: Contact data: example: testing created_at: '2024-03-15T15:34:28.264Z' - id: null public_id: UmaByF workspace_id: 42 uuid: 1348d7e7d3798c6031102ff3e1b01175 event_type_id: contact.identified subject_id: 127 subject_type: Contact data: example: testing created_at: '2024-03-15T15:34:28.281Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEventListForWorkspace401Response example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEventListForWorkspace404Response example: error: 'Not found: Record missing' /webhooks/outgoing/events/{id}: get: tags: - Webhooks::Outgoing::Event summary: Fetch Event operationId: WebhooksOutgoingEvent_getForWorkspace description: Retrieve an webhook event for a workspace parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhooksOutgoingEventAttributes' example: id: null public_id: MxIeDG workspace_id: 42 uuid: 102fcc2a069b89b7e677b136f41c9ce5 event_type_id: contact.identified subject_id: 128 subject_type: Contact data: example: testing created_at: '2024-03-15T15:34:28.314Z' '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEventGetForWorkspaceResponse example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/WebhooksOutgoingEventGetForWorkspace404Response example: error: 'Not found: Record missing' components: parameters: id: name: id in: path required: true schema: type: string after: description: ID of item after which the collection should be returned name: after in: query required: false schema: type: string sort_order: description: >- Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. name: sort_order in: query required: false schema: type: string enum: - asc - desc securitySchemes: BearerAuth: type: http scheme: bearer schemas: ContactTagAttributes: title: Contact Tags description: Contact Tags type: object required: - id - name properties: id: description: The ID of the tag type: string name: description: The name of the tag type: string color: description: The color of the tag type: string OrderSegmentAttributes: title: Order Segments description: Order Segments type: object required: - id - name properties: id: description: The ID of the segment type: string name: description: The name of the segment type: string OrderContactGroupAttributes: title: Contact Groups description: Contact Groups type: object required: - id - name properties: id: description: The ID of the contact group type: string name: description: The name of the contact group type: string TeamAttributes: title: Teams description: Teams type: object required: - id - name properties: id: description: Team ID type: integer public_id: description: Team public ID type: - string - 'null' name: description: Team type: string time_zone: description: Primary time zone type: - string - 'null' locale: description: Language type: - string - 'null' created_at: description: Created type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 42 public_id: tepQnf name: Example Team time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-03-15T15:33:38.620Z' updated_at: '2024-03-15T15:33:38.620Z' TeamParameters: title: Teams description: Teams type: object required: - name properties: name: description: Team type: string time_zone: description: Primary time zone type: - string - 'null' locale: description: Language type: - string - 'null' example: name: Example Team time_zone: Pacific Time (US & Canada) locale: en UserAttributes: title: Profile description: Profile type: object required: - id - email - first_name - last_name properties: id: description: User ID type: integer public_id: description: User public ID type: - string - 'null' email: description: Email Address type: string first_name: description: First Name type: string last_name: description: Last Name type: string time_zone: description: Your Time Zone type: - string - 'null' locale: description: Language type: - string - 'null' created_at: description: Signed up type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: pFaoer email: regena.rowe@grimes.co first_name: Zachary last_name: Schaefer time_zone: Pacific Time (US & Canada) locale: en created_at: '2024-04-15T15:33:39.107Z' updated_at: '2024-04-15T15:33:39.107Z' UserParameters: title: Profile description: Profile type: object required: - email - first_name - last_name properties: email: description: Email Address type: string first_name: description: First Name type: string last_name: description: Last Name type: string time_zone: description: Your Time Zone type: - string - 'null' locale: description: Language type: - string - 'null' example: email: regena.rowe@grimes.co first_name: Zachary last_name: Schaefer time_zone: Pacific Time (US & Canada) locale: en WorkspaceAttributes: title: Workspaces description: Workspaces type: object required: - id - team_id - name - subdomain properties: id: description: Workspace ID type: integer public_id: description: Workspace public ID type: - string - 'null' team_id: description: Team ID type: integer name: description: Workspace name type: string subdomain: description: Subdomain type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 42 public_id: wyJcAa team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:39.165Z' updated_at: '2024-03-15T15:33:39.165Z' WorkspaceParameters: title: Workspaces description: Workspaces type: object required: - name - subdomain properties: name: description: Workspace name type: string subdomain: description: Subdomain type: string example: name: Example Workspace subdomain: example ContactAttributes: title: Contacts description: Contacts type: object required: - id - workspace_id - uuid properties: tags: description: Contact Tags type: - array - 'null' items: $ref: '#/components/schemas/ContactTagAttributes' id: description: Contact ID type: integer public_id: description: Contact public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer anonymous: description: Anonymous type: - string - 'null' email_address: description: Email address type: - string - 'null' first_name: description: First name type: - string - 'null' last_name: description: Last name type: - string - 'null' phone_number: description: Phone number type: - string - 'null' time_zone: description: Time Zone type: - string - 'null' uuid: description: UUID type: string unsubscribed_at: description: Unsubscribed type: - string - 'null' last_notification_email_sent_at: description: Last notification email sent type: - string - 'null' fb_url: description: Facebook URL type: - string - 'null' twitter_url: description: Twitter URL type: - string - 'null' instagram_url: description: Instagram URL type: - string - 'null' linkedin_url: description: Linkedin URL type: - string - 'null' website_url: description: Website URL type: - string - 'null' created_at: description: Date added type: - string - 'null' format: date-time updated_at: description: Last updated type: - string - 'null' format: date-time example: tags: - id: 1 public_id: brRfiy name: Example Tag color: '#729c6b' id: 1 public_id: SYKdHI workspace_id: 42 anonymous: null email_address: test-2ea19f39988b38755344@example.com first_name: Cory last_name: Rosenbaum phone_number: 234.346.5721 x8239 time_zone: Pacific Time (US & Canada) uuid: 90903482-60ae-4cbf-88e3-8b9d117c2fc9 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:39.318Z' updated_at: '2024-03-15T15:33:39.318Z' ContactParameters: title: Contacts description: Contacts type: object required: [] properties: email_address: description: Email address type: - string - 'null' first_name: description: First name type: - string - 'null' last_name: description: Last name type: - string - 'null' phone_number: description: Phone number type: - string - 'null' time_zone: description: Time Zone type: - string - 'null' fb_url: description: Facebook URL type: - string - 'null' twitter_url: description: Twitter URL type: - string - 'null' instagram_url: description: Instagram URL type: - string - 'null' linkedin_url: description: Linkedin URL type: - string - 'null' website_url: description: Website URL type: - string - 'null' tag_ids: description: >- Contact Tag IDs. Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Contact endpoint, then be sure to include the existing tags in your payload along with any new addition(s) type: array items: type: integer example: email_address: test-2ea19f39988b38755344@example.com first_name: Cory last_name: Rosenbaum phone_number: 234.346.5721 x8239 time_zone: Pacific Time (US & Canada) fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com ContactsAppliedTagAttributes: title: Contacts Applied Tags description: Contacts Applied Tags type: object required: - id - contact_id - tag_id properties: id: description: Applied Tag ID type: integer public_id: description: Applied Tag public ID type: - string - 'null' contact_id: description: Contact ID type: integer tag_id: description: Tag ID type: integer created_at: description: Date added type: - string - 'null' format: date-time updated_at: description: Last updated type: - string - 'null' format: date-time example: id: 1 public_id: aFwvdy contact_id: 2 tag_id: 3 created_at: '2024-04-08T15:33:39.397Z' updated_at: '2024-04-08T15:33:39.398Z' ContactsAppliedTagParameters: title: Contacts Applied Tags description: Contacts Applied Tags type: object required: - tag_id properties: tag_id: description: Tag ID type: integer example: tag_id: 3 ContactsTagAttributes: title: Contact Tags description: Contact Tags type: object required: - id - workspace_id - name - color properties: id: description: Tag ID type: integer public_id: description: Tag public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Name type: string color: description: Color type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 4 public_id: HoQpYi workspace_id: 42 name: Example Tag color: '#b569d2' created_at: '2024-04-15T15:33:39.456Z' updated_at: '2024-04-15T15:33:39.456Z' ContactsTagParameters: title: Contact Tags description: Contact Tags type: object required: - name - color properties: name: description: Name type: string color: description: Color type: string example: name: Example Tag color: '#b569d2' CourseAttributes: title: Courses description: Courses type: object required: - id - title - description properties: title: description: Title type: string description: description: Description type: string id: description: Course ID type: integer public_id: description: Course public ID type: - string - 'null' published_at: description: Available at type: - string - 'null' format: date-time root_section_id: description: Root section type: - string - 'null' current_path: description: Course Path URL type: - string - 'null' sharing_fingerprint: description: Sharing Fingerprint type: - string - 'null' show_in_community: description: Show In LearningHub? type: - boolean - 'null' show_to_non_members: description: Show To Non Members type: - boolean - 'null' upgrade_url: description: Upgrade URL type: - string - 'null' redirect_to_full_course: description: Redirect To Full Course type: - boolean - 'null' unauthorized_redirect_url: description: Unauthorized Redirect type: - string - 'null' comments_enabled: description: Enable Lesson Comments? type: - boolean - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: title: Example Course description: Ullam in laborum. Minus et iure. Adipisci quia aperiam. id: 1 public_id: xDEMUl published_at: '2024-04-08T15:33:39.000Z' root_section_id: null current_path: null sharing_fingerprint: null show_in_community: false show_to_non_members: false upgrade_url: null redirect_to_full_course: true unauthorized_redirect_url: null comments_enabled: false created_at: '2024-04-08T15:33:39.641Z' updated_at: '2024-04-08T15:33:39.642Z' CoursesEnrollmentAttributes: title: Enrollments description: Enrollments type: object required: - id - contact_id - course_id - origination_source_id properties: id: description: Enrollment ID type: integer public_id: description: Enrollment public ID type: - string - 'null' contact_id: description: Contact ID type: integer course_id: description: Course type: integer created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time suspended: description: Suspended type: - boolean - 'null' suspension_reason: description: Suspension Reason type: - string - 'null' current_path: description: Current Path type: - string - 'null' origination_source_type: description: Origination Source Type type: - string - 'null' origination_source_id: description: Origination Source ID type: integer example: id: 1 public_id: tjxqAJ contact_id: 3 course_id: 2 created_at: '2024-02-15T15:33:40.205Z' updated_at: '2024-03-15T15:33:40.205Z' suspended: false suspension_reason: Call in to reapply after robot incident current_path: >- /enrollments/3affca1c0efa8c415a67ff4b12214e2d412edf2a0ba8366ebf666cdaeeb07c7333 origination_source_type: Membership origination_source_id: 1 CoursesEnrollmentParameters: title: Enrollments description: Enrollments type: object required: - contact_id properties: contact_id: description: Contact ID type: integer suspended: description: Suspended type: - boolean - 'null' suspension_reason: description: Suspension Reason type: - string - 'null' example: contact_id: 3 suspension_reason: Call in to reapply after robot incident CoursesSectionAttributes: title: Modules description: Modules type: object required: - id - course_id - title - blocker_lesson_id properties: title: description: Title type: string description: description: Description type: - string - 'null' id: description: ID type: string public_id: description: Public ID type: - string - 'null' course_id: description: Course ID type: string published_at: description: Published at type: - string - 'null' days_till_drip_access: description: Days until drip access type: - string - 'null' blocker_section_id: description: Blocker section type: - string - 'null' blocker_lesson_id: description: Blocker lesson type: string current_path: description: Current Path type: - string - 'null' is_hidden_from_non_members: description: Current Path type: - boolean - 'null' upgrade_url: description: Upgrade URL type: - string - 'null' created_at: description: Date added type: - string - 'null' updated_at: description: Updated type: - string - 'null' example: title: Module 1 description: null id: null public_id: gecfQw course_id: null published_at: null days_till_drip_access: null blocker_section_id: null blocker_lesson_id: null current_path: null is_hidden_from_non_members: true upgrade_url: null created_at: null updated_at: null CoursesSectionParameters: title: Modules description: Modules type: object required: - title - blocker_lesson_id properties: title: description: Title type: string description: description: Description type: - string - 'null' days_till_drip_access: description: Days until drip access type: - string - 'null' blocker_section_id: description: Blocker section type: - string - 'null' blocker_lesson_id: description: Blocker lesson type: string is_hidden_from_non_members: description: Current Path type: - boolean - 'null' example: title: Module 1 is_hidden_from_non_members: true CoursesLessonAttributes: title: Lessons description: Lessons type: object required: - id - title properties: title: description: Title type: string id: description: ID type: string public_id: description: Public ID type: - string - 'null' body: description: Description type: - string - 'null' section_id: description: Parent module type: - string - 'null' published_at: description: Schedule for type: - string - 'null' current_path: description: Current Path type: - string - 'null' created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' example: title: Lesson 1 id: null public_id: cTpgvy body: null section_id: null published_at: null current_path: null created_at: null updated_at: null CoursesLessonParameters: title: Lessons description: Lessons type: object required: - title properties: title: description: Title type: string body: description: Description type: - string - 'null' example: title: Lesson 1 FormAttributes: title: Forms description: Forms type: object required: - id - workspace_id - name properties: id: description: Form ID type: integer public_id: description: Form public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Name type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: ljcvhM workspace_id: 42 name: Example Form created_at: '2024-04-15T15:33:40.413Z' updated_at: '2024-04-15T15:33:40.413Z' FormParameters: title: Forms description: Forms type: object required: - name properties: name: description: Name type: string example: name: Example Form FormsFieldSetAttributes: title: Field sets description: Field sets type: object required: - id - form_id - title properties: title: description: Title type: string id: description: Field set ID type: integer public_id: description: Field set public ID type: - string - 'null' form_id: description: Form ID type: integer created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: title: Example Field Set id: 1 public_id: zjtfCp form_id: 2 created_at: '2024-04-15T15:33:40.495Z' updated_at: '2024-04-15T15:33:40.495Z' FormsFieldSetParameters: title: Field sets description: Field sets type: object required: - title properties: title: description: Title type: string example: title: Example Field Set FormsFieldAttributes: title: Fields description: Fields type: object required: - id - field_set_id - label properties: id: description: Field ID type: integer public_id: description: Field public ID type: - string - 'null' field_set_id: description: Field set ID type: integer label: description: Label type: string field_type: description: Field Type type: - string - 'null' allow_multiple: description: Allow Multiple type: - boolean - 'null' key: description: Key type: - string - 'null' hidden: description: Hidden type: - boolean - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: MCJWoc field_set_id: 2 label: MyString field_type: MyString allow_multiple: false key: null hidden: false created_at: '2024-04-15T15:33:40.627Z' updated_at: '2024-04-15T15:33:40.627Z' FormsFieldParameters: title: Fields description: Fields type: object required: - label properties: label: description: Label type: string field_type: description: Field Type type: - string - 'null' allow_multiple: description: Allow Multiple type: - boolean - 'null' key: description: Key type: - string - 'null' hidden: description: Hidden type: - boolean - 'null' example: label: MyString field_type: MyString FormsFieldsOptionAttributes: title: Options description: Options type: object required: - id - field_id - label properties: id: description: Option ID type: integer public_id: description: Option public ID type: - string - 'null' field_id: description: Field ID type: integer label: description: Label type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 5 public_id: jqtaMP field_id: 2 label: voluptatem created_at: '2024-04-15T15:33:40.727Z' updated_at: '2024-04-15T15:33:40.727Z' FormsFieldsOptionParameters: title: Options description: Options type: object required: - label properties: label: description: Label type: string example: label: voluptatem FormsSubmissionAttributes: title: Submissions description: Submissions type: object required: - id - form_id properties: id: description: Submission ID type: integer public_id: description: Submission public ID type: - string - 'null' form_id: description: Form ID type: integer contact_id: description: Contact type: - integer - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: EwUTFg form_id: 7 contact_id: 4 created_at: '2024-04-15T15:33:40.811Z' updated_at: '2024-04-15T15:33:40.811Z' FormsSubmissionParameters: title: Submissions description: Submissions type: object required: [] properties: contact_id: description: Contact type: - integer - 'null' example: contact_id: 4 FormsSubmissionsAnswerAttributes: title: Answers description: Answers type: object required: - id - submission_id - field_id properties: id: description: Answer ID type: integer public_id: description: Answer public ID type: - string - 'null' submission_id: description: Submission ID type: integer field_id: description: Field type: integer fields_option_id: description: Fields Option type: - integer - 'null' entry: description: Entry type: - string - 'null' fields_option_ids: description: Fields Options type: - array - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: sTHvfE submission_id: 2 field_id: 3 fields_option_id: 8 entry: MyText fields_option_ids: [] created_at: '2024-04-15T15:33:40.903Z' updated_at: '2024-04-15T15:33:40.903Z' FormsSubmissionsAnswerParameters: title: Answers description: Answers type: object required: - field_id properties: field_id: description: Field type: integer fields_option_id: description: Fields Option type: - integer - 'null' entry: description: Entry type: - string - 'null' fields_option_ids: description: Fields Options type: - array - 'null' example: field_id: 3 fields_option_id: 8 entry: MyText FormSubmissionAttributes: title: Form submissions description: Form submissions type: object required: - id - workspace_id properties: id: description: Form submission ID type: integer public_id: description: Public ID type: - string - 'null' contact_id: description: Contact ID type: - integer - 'null' workspace_id: description: Workspace ID type: integer page_id: description: Page ID type: - integer - 'null' created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' data: description: Form Submission Data type: - object - 'null' properties: email: description: Email type: string phone: description: Phone type: string full_name: description: Full Name type: string t_shirt_size: description: T-Shirt Size type: string example: id: 1 public_id: bUcNES contact_id: 6 workspace_id: 42 page_id: 1 created_at: null updated_at: null data: email: test@example.com phone: 123-456-7890 full_name: Test User t_shirt_size: L FormSubmissionParameters: title: Form submissions description: Form submissions type: object required: [] properties: contact_id: description: Contact ID type: - integer - 'null' page_id: description: Page ID type: - integer - 'null' data: description: Form Submission Data type: - object - 'null' properties: email: description: Email type: string phone: description: Phone type: string full_name: description: Full Name type: string t_shirt_size: description: T-Shirt Size type: string example: contact_id: 6 page_id: 1 data: email: test@example.com phone: 123-456-7890 full_name: Test User t_shirt_size: L FulfillmentAttributes: title: Fulfillments description: Fulfillments type: object required: - id - workspace_id - contact_id - status - location_id properties: id: description: Fulfillment ID type: integer public_id: description: >- The fulfillment ID that would be visible to the customer within the CF app type: - string - 'null' workspace_id: description: The workspace that the fulfillment belongs to type: integer contact_id: description: The contact that made the order that is being fulfilled. type: integer status: description: The status of the fulfillment type: string enum: - cancelled - fulfilled - restocked tracking_url: description: Tracking URL type: - string - 'null' shipping_provider: description: Shipping Provider type: - string - 'null' tracking_code: description: Tracking Code type: - string - 'null' location_id: description: The location that the fulfillment is being fulfilled from type: integer fulfillment_number: description: An auto-generated number of the fulfillment type: - integer - 'null' created_at: description: Created type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time included_invoices_line_items: description: >- Line items that are included in your fulfillment. They reference invoice line items of one or more orders and have extra data about the line item that is being fulfilled like the quantity that is part of this fulfillment. type: - array - 'null' items: title: Included orders invoices line item description: >- The orders invoice line item to fulfill as part of this fulfillment type: object required: - id - fulfillment_id - quantity - invoices_line_item_id properties: id: description: Included orders line item ID type: integer public_id: description: The public ID of the included order invoices line item type: - string - 'null' fulfillment_id: description: Fulfillment ID type: integer quantity: description: >- The quantity of the invoices line item subject that is part of this fulfillment. Your stock must have enough quantity for a successful fulfillment. type: integer invoices_line_item_id: description: >- The invoice line item of an order that is part of this fulfillment. type: integer example: id: 1 public_id: QrjvkE workspace_id: 42 contact_id: 7 status: fulfilled tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 1 fulfillment_number: 1 created_at: '2024-03-15T15:33:42.867Z' updated_at: '2024-03-15T15:33:42.867Z' included_invoices_line_items: - id: 1 public_id: PYvAJe fulfillment_id: 1 quantity: 1 invoices_line_item_id: 12 FulfillmentParameters: title: Fulfillments description: Fulfillments type: object required: - contact_id - location_id - included_orders_invoices_line_items_attributes properties: contact_id: description: The contact that made the order that is being fulfilled. type: integer tracking_url: description: Tracking URL type: - string - 'null' shipping_provider: description: Shipping Provider type: - string - 'null' tracking_code: description: Tracking Code type: - string - 'null' location_id: description: The location that the fulfillment is being fulfilled from type: integer ignore_out_of_stock: description: Create a fulfillment despite the item being out of stock. type: boolean notify_customer: description: Send an email to the customer when the fulfillment is created. type: boolean included_orders_invoices_line_items_attributes: description: >- The orders invoices line items to fulfill as part of this fulfillment. type: array items: type: object properties: invoices_line_item_id: description: The orders invoice line item to fulfill type: string quantity: description: The quantity to fulfill type: integer example: contact_id: 7 tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' location_id: 1 ImageAttributes: title: Images description: Images type: object required: - id - workspace_id properties: id: description: Image ID type: integer public_id: description: Public ID type: - string - 'null' url: description: The URL of the image type: string workspace_id: description: Workspace ID type: integer alt_text: description: Image alt attribute type: - string - 'null' name: description: Image name type: - string - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 5 public_id: VfjpBa url: /uploads/image/1/file/9c8d1e7d480dc9882c519d4b4528826f.png workspace_id: 42 alt_text: Alt text of the image name: Amazing Shot created_at: '2024-03-15T15:33:42.943Z' updated_at: '2024-03-15T15:33:42.943Z' ImageParameters: title: Images description: Images type: object required: - upload_source_url properties: alt_text: description: Image alt attribute type: - string - 'null' name: description: Image name type: - string - 'null' upload_source_url: description: >- The source URL of the image that you want to upload. Not required on Update when not needed to re-upload the image. type: string example: alt_text: Alt text of the image name: Amazing Shot upload_source_url: https://image-hosting-x.com/cdn/123 OrderAttributes: title: Orders description: Orders type: object required: - id - workspace_id - contact_id - currency - origination_channel_id - contact - workspace properties: id: description: ClickFunnels Order ID type: integer public_id: description: ClickFunnels Order public ID type: - string - 'null' order_number: description: Order Number type: - string - 'null' workspace_id: description: ClickFunnels Workspace ID type: integer contact_id: description: Customer type: integer total_amount: description: Total type: - string - 'null' currency: description: Currency type: string origination_channel_id: description: Origination Channel ID type: integer origination_channel_type: description: Origination Channel Type type: - string - 'null' shipping_address_first_name: description: First Name type: - string - 'null' shipping_address_last_name: description: Last Name type: - string - 'null' shipping_address_organization_name: description: Organization Name type: - string - 'null' shipping_address_phone_number: description: Phone Number type: - string - 'null' shipping_address_street_one: description: Street One type: - string - 'null' shipping_address_street_two: description: Street Two type: - string - 'null' shipping_address_city: description: City type: - string - 'null' shipping_address_region: description: State type: - string - 'null' shipping_address_country: description: Country type: - string - 'null' shipping_address_postal_code: description: Postal Code type: - string - 'null' billing_address_street_one: description: Street One type: - string - 'null' billing_address_street_two: description: Street Two type: - string - 'null' billing_address_city: description: City type: - string - 'null' billing_address_region: description: State type: - string - 'null' billing_address_country: description: Country type: - string - 'null' billing_address_postal_code: description: Postal Code type: - string - 'null' page_id: description: Page ID type: - integer - 'null' notes: description: Notes type: - string - 'null' in_trial: description: In Trial type: - boolean - 'null' billing_status: description: Billing Status type: - string - 'null' service_status: description: Order Status type: - string - 'null' order_type: description: Order Type type: - string - 'null' next_charge_at: description: Next Charge At type: - string - 'null' tax_amount: description: Tax Amount type: - string - 'null' trial_end_at: description: Trial End At type: - string - 'null' billing_payment_method_id: description: Payment Method type: - string - 'null' funnel_name: description: Funnel Name type: - string - 'null' tag_ids: description: Order Tags type: - array - 'null' minContains: 0 contains: type: integer discount_ids: description: Discounts type: - array - 'null' activated_at: description: Date Activated type: - string - 'null' workspace_sharing_id: description: Workspace Sharing ID type: - string - 'null' canceled_at: description: 'Translation missing: en.orders.fields.canceled_at.api_description' type: - string - 'null' canceled_by: description: 'Translation missing: en.orders.fields.canceled_by.api_description' type: - string - 'null' cancel_reason: description: 'Translation missing: en.orders.fields.cancel_reason.api_description' type: - string - 'null' cancel_description: description: >- Translation missing: en.orders.fields.cancel_description.api_description type: - string - 'null' churned_at: description: 'Translation missing: en.orders.fields.churned_at.api_description' type: - string - 'null' created_at: description: Date Ordered type: - string - 'null' format: date-time updated_at: description: Date Updated type: - string - 'null' format: date-time phone_number: description: Phone Number type: - string - 'null' page_name: description: Page Name type: - string - 'null' origination_channel_name: description: Origination Channel Name type: - string - 'null' order_page: title: Pages description: Page type: - object - 'null' required: - id - name properties: id: description: ClickFunnels Page ID type: integer public_id: description: ClickFunnels Page Public ID type: - string - 'null' name: description: Page name type: string contact: $ref: '#/components/schemas/ContactAttributes' contact_groups: description: Contact Groups type: - array - 'null' items: $ref: '#/components/schemas/OrderContactGroupAttributes' workspace: $ref: '#/components/schemas/WorkspaceAttributes' segments: description: Segments type: - array - 'null' items: $ref: '#/components/schemas/OrderSegmentAttributes' line_items: description: Order Line Items type: - array - 'null' items: $ref: '#/components/schemas/OrdersLineItemAttributes' previous_line_item: description: >- An additional field, only available in outgoing subscription.upgrade/subscription.downgrade webhooks. It enables you to identify the former line item which is otherwise removed from the regular subscription line items when an upgrade or downgrade happens. Thus you can see the data of the previously active subscription. This property will not appear in regular API requests, but only in the event of a subscription upgrade or downgrade. type: - string - 'null' example: id: 2 public_id: LFJOvd order_number: '974930' workspace_id: 42 contact_id: 9 total_amount: '123.00' currency: USD origination_channel_id: 3 origination_channel_type: User shipping_address_first_name: Leslie shipping_address_last_name: Berge shipping_address_organization_name: Testing, Inc. shipping_address_phone_number: '+19053871234' shipping_address_street_one: 925 Jacobs Square shipping_address_street_two: Suite 343 shipping_address_city: Port Michalville shipping_address_region: WA shipping_address_country: US shipping_address_postal_code: '56545' billing_address_street_one: 618 Danika Green billing_address_street_two: Apt. 509 billing_address_city: Claudeland billing_address_region: WA billing_address_country: US billing_address_postal_code: '11277' page_id: 3 notes: Sapiente consequatur incidunt repellendus. in_trial: false billing_status: pending service_status: pending order_type: one-time-order next_charge_at: null tax_amount: '0.00' trial_end_at: null billing_payment_method_id: null funnel_name: null tag_ids: - 2 discount_ids: [] activated_at: null workspace_sharing_id: null canceled_at: null canceled_by: null cancel_reason: null cancel_description: null churned_at: null created_at: '2024-03-15T15:33:43.413Z' updated_at: '2024-03-15T15:33:43.413Z' phone_number: (471) 964-4760 x421 page_name: Example Page origination_channel_name: '' order_page: id: 3 public_id: NHUrFh name: Example Page contact: tags: - id: 11 public_id: dBsQWm name: Example Tag color: '#ab4d9b' id: 9 public_id: lKSqeY workspace_id: 42 anonymous: null email_address: test-9096bb40d0aa26a83cce@example.com first_name: Shawna last_name: Crona phone_number: (471) 964-4760 x421 time_zone: Pacific Time (US & Canada) uuid: 9d9ab0c5-3bae-45ea-8d7d-effc11970213 unsubscribed_at: null last_notification_email_sent_at: null fb_url: https://www.facebook.com/example twitter_url: https://twitter.com/example instagram_url: null linkedin_url: https://www.linkedin.com/in/example website_url: https://example.com created_at: '2024-03-15T15:33:43.030Z' updated_at: '2024-03-15T15:33:43.030Z' contact_groups: - id: 2 public_id: VZGWLE name: Example Group workspace: id: 42 public_id: MAeULV team_id: 42 name: Example Workspace subdomain: example created_at: '2024-03-15T15:33:43.007Z' updated_at: '2024-03-15T15:33:43.007Z' segments: - id: 2 public_id: wsEXuq name: Example Segment line_items: - id: 2 public_id: OJMAJB order_id: 2 quantity: 1 prorated: null created_at: '2024-02-14T03:01:09.705Z' updated_at: '2024-04-04T19:27:01.596Z' original_product: id: 2 public_id: ONMANq name: My Team's First Product products_price: id: 2 public_id: ONMANq amount: '29.0' currency: usd duration: null interval: null interval_count: null products_variant: description: null id: 2 public_id: ONMANq name: My Team's First Product sku: null - id: 2 public_id: xIPQke order_id: 2 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 5 public_id: vnWfep name: Heavy Duty Copper Bag 54de73 products_price: id: 4 public_id: PrFmTs amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Labore quia alias delectus. id: 4 public_id: uLKXip name: Sleek Paper Bottle variant 5c42 sku: jzJhpyKega93qNyt previous_line_item: null x-konfig-properties: contact: description: Customer Email type: object workspace: description: Workspace type: object OrderParameters: title: Orders description: Orders type: object required: [] properties: notes: description: Notes type: - string - 'null' example: notes: Sapiente consequatur incidunt repellendus. OrdersAppliedTagAttributes: title: Orders Applied Tags description: Orders Applied Tags type: object required: - id - order_id - tag_id properties: id: description: Applied Tag ID type: integer public_id: description: Applied Tag public ID type: - string - 'null' order_id: description: Order ID type: integer tag_id: description: Tag ID type: integer created_at: description: Date added type: - string - 'null' format: date-time updated_at: description: Last updated type: - string - 'null' format: date-time example: id: 1 public_id: eYIBDV order_id: 3 tag_id: 4 created_at: '2024-04-15T15:33:44.182Z' updated_at: '2024-04-15T15:33:44.182Z' OrdersAppliedTagParameters: title: Orders Applied Tags description: Orders Applied Tags type: object required: - tag_id properties: tag_id: description: Tag ID type: integer example: tag_id: 4 OrdersInvoiceAttributes: title: Invoices description: Invoices type: object required: - id - order_id - status - invoice_number properties: id: description: Invoice ID type: integer public_id: description: Invoice public ID type: - string - 'null' order_id: description: Creative concept ID type: integer status: description: Status type: string due_amount: description: Due Amount type: - string - 'null' total_amount: description: Total Amt type: - string - 'null' subtotal_amount: description: Subtotal Amount type: - string - 'null' tax_amount: description: Tax Amount type: - string - 'null' shipping_amount: description: Shipping Amount type: - string - 'null' discount_amount: description: Discount Amount type: - string - 'null' currency: description: Currency type: - string - 'null' issued_at: description: Issued At type: - string - 'null' format: date-time due_at: description: Due At type: - string - 'null' format: date-time paid_at: description: Paid At type: - string - 'null' format: date-time invoice_type: description: Invoice Type type: string enum: - initial - renewal - interim - cancellation - one_time - refund - charge - one_time_sale invoice_number: description: Invoice number type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time line_items: description: Invoice Line Items type: - array - 'null' items: $ref: '#/components/schemas/OrdersInvoicesLineItemAttributes' example: id: 2 public_id: gCyRZk order_id: 4 status: paid due_amount: '0.00' total_amount: '9.99' subtotal_amount: '9.99' tax_amount: '9.99' shipping_amount: '9.99' discount_amount: '9.99' currency: USD issued_at: '2024-03-15T15:33:44.000Z' due_at: '2024-04-22T15:33:44.000Z' paid_at: '2024-04-08T15:33:44.000Z' invoice_type: null invoice_number: '99' created_at: '2024-03-15T15:33:44.837Z' updated_at: '2024-03-15T15:33:44.837Z' line_items: - description: Example Description id: 3 public_id: kpUFTz invoice_id: 2 external_id: Example External ID payment_type: one_time amount: '9.99' quantity: 1 fulfillment_status: unfulfilled external_product_id: Example External Product ID discount_amount: '9.99' state_tax_amount: '3.33' county_tax_amount: '3.33' city_tax_amount: '2.22' district_tax_amount: '1.11' state_tax_rate: '0.3' county_tax_rate: '0.3' city_tax_rate: '0.2' district_tax_rate: '0.1' country_tax_jurisdiction: Example Country Tax Jurisdiction state_tax_jurisdiction: Example State Tax Jurisdiction county_tax_jurisdiction: Example County Tax Jurisdiction city_tax_jurisdiction: Example City Tax Jurisdiction period_start_at: null period_end_at: null period_number: null created_at: null updated_at: null products_price: id: 7 public_id: TSlphr amount: '100.0' currency: USD duration: 1 interval: months interval_count: 1 products_variant: description: Perferendis et dolore voluptate. id: 7 public_id: GLwgdO product_id: 11 name: Synergistic Marble Hat variant 8582 sku: Ssnrvt1IALDhFg0A fulfillment_required: false OrdersInvoicesLineItemAttributes: title: Line items description: Line items type: object required: - id - invoice_id - external_id properties: description: description: Description type: - string - 'null' id: description: Line item ID type: integer public_id: description: ClickFunnels line item public ID type: - string - 'null' invoice_id: description: Invoice ID type: integer external_id: description: External type: string payment_type: description: Payment Type type: - string - 'null' amount: description: Amount type: - number - 'null' quantity: description: Quantity type: - integer - 'null' fulfillment_status: description: Represents the current fulfillment status of the line item type: string enum: - unfulfilled - partially_fulfilled - complete - ignored external_product_id: description: External Product type: - string - 'null' discount_amount: description: Discount Amount type: - number - 'null' state_tax_amount: description: State Tax Amount type: - number - 'null' county_tax_amount: description: County Tax Amount type: - number - 'null' city_tax_amount: description: City Tax Amount type: - number - 'null' district_tax_amount: description: District Tax Amount type: - number - 'null' state_tax_rate: description: State Tax Rate type: - number - 'null' county_tax_rate: description: County Tax Rate type: - number - 'null' city_tax_rate: description: City Tax Rate type: - number - 'null' district_tax_rate: description: District Tax Rate type: - number - 'null' country_tax_jurisdiction: description: Country Tax Jurisdiction type: - string - 'null' state_tax_jurisdiction: description: State Tax Jurisdiction type: - string - 'null' county_tax_jurisdiction: description: County Tax Jurisdiction type: - string - 'null' city_tax_jurisdiction: description: City Tax Jurisdiction type: - string - 'null' period_start_at: description: Period Start At type: - string - 'null' period_end_at: description: Period End At type: - string - 'null' period_number: description: Period Number type: - string - 'null' created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' products_price: title: Product Price description: Product Price type: - object - 'null' required: - id - amount - currency - duration - interval - interval_count properties: id: description: ID type: integer public_id: description: Price public ID type: - string - 'null' amount: description: Amount type: string currency: description: Currency type: string duration: description: Duration type: integer interval: description: Interval type: string interval_count: description: Interval count type: integer products_variant: title: Product Variant description: Product Variant type: - object - 'null' required: - id - product_id - name properties: description: description: Description type: - string - 'null' id: description: ID type: integer public_id: description: Variant public ID type: - string - 'null' product_id: description: Product ID type: integer name: description: Name type: string sku: description: SKU type: - string - 'null' fulfillment_required: description: Fulfillment required type: - boolean - 'null' example: description: Example Description id: 5 public_id: QcGiqM invoice_id: 3 external_id: Example External ID payment_type: one_time amount: '9.99' quantity: 1 fulfillment_status: unfulfilled external_product_id: Example External Product ID discount_amount: '9.99' state_tax_amount: '3.33' county_tax_amount: '3.33' city_tax_amount: '2.22' district_tax_amount: '1.11' state_tax_rate: '0.3' county_tax_rate: '0.3' city_tax_rate: '0.2' district_tax_rate: '0.1' country_tax_jurisdiction: Example Country Tax Jurisdiction state_tax_jurisdiction: Example State Tax Jurisdiction county_tax_jurisdiction: Example County Tax Jurisdiction city_tax_jurisdiction: Example City Tax Jurisdiction period_start_at: null period_end_at: null period_number: null created_at: null updated_at: null products_price: id: 10 public_id: qOTFpa amount: '100.0' currency: USD duration: 1 interval: months interval_count: 1 products_variant: description: Et ut ut molestias. id: 10 public_id: LVsNxR product_id: 15 name: Small Bronze Gloves variant dbb7 sku: Ydles4Agtiu1wE7Z fulfillment_required: false OrdersTransactionAttributes: title: Payments description: Payments type: object required: - id - order_id - status - external_id - result properties: id: description: Transaction ID type: integer public_id: description: Transaction public ID type: - string - 'null' order_id: description: Order ID type: integer status: description: Status type: string external_type: description: Type type: - string - 'null' external_id: description: External ID type: string amount: description: Amount type: - string - 'null' currency: description: Currency type: - string - 'null' reason: description: Reason type: - string - 'null' adjusted_transaction_id: description: Adjusted transaction type: - string - 'null' result: description: Result type: string billing_payment_instruction_id: description: Billing Payment Instruction ID type: - string - 'null' billing_payment_instruction_type: description: Billing Payment Instruction Type type: - string - 'null' arn: description: Arn type: - string - 'null' is_rebill: description: Is Rebill type: - boolean - 'null' rebill_number: description: Rebill Number type: - string - 'null' created_at: description: Created type: - string - 'null' updated_at: description: Updated type: - string - 'null' example: id: 1 public_id: jdUtRk order_id: 6 status: completed external_type: sale external_id: 70982711fd5d65eebf59b4f143b93f6c amount: '100.00' currency: USD reason: null adjusted_transaction_id: null result: approved billing_payment_instruction_id: null billing_payment_instruction_type: null arn: null is_rebill: false rebill_number: null created_at: null updated_at: null OrdersTagAttributes: title: Order Tags description: Order Tags type: object required: - id - workspace_id - name - color properties: id: description: Tag ID type: integer public_id: description: Tag public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Name type: string color: description: Color type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 8 public_id: FGamOw workspace_id: 42 name: Example Tag color: '#585673' created_at: '2024-04-15T15:33:46.224Z' updated_at: '2024-04-15T15:33:46.224Z' OrdersTagParameters: title: Order Tags description: Order Tags type: object required: - name - color properties: name: description: Name type: string color: description: Color type: string example: name: Example Tag color: '#585673' OrdersLineItemAttributes: title: Line items description: Line items type: object required: - id - order_id - original_product - products_price properties: id: description: Line item ID type: integer public_id: description: Line item public ID type: - string - 'null' order_id: description: Order ID type: integer quantity: description: Quantity type: - integer - 'null' prorated: description: Prorate invoice type: - string - 'null' created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' original_product: title: Product description: Product type: object required: - id - name properties: id: description: ID type: integer name: description: Product name type: string products_price: title: Product Price description: Product Price type: object required: - id - amount - currency - duration - interval - interval_count properties: id: description: ID type: integer amount: description: Amount type: string currency: description: Currency type: string duration: description: Duration type: integer interval: description: Interval type: string interval_count: description: Interval count type: string products_variant: title: Product Variant description: Product Variant type: - object - 'null' required: - id - name properties: description: description: Description type: - string - 'null' id: description: ID type: integer name: description: Name type: string sku: description: SKU type: - string - 'null' example: id: 8 public_id: INrLuQ order_id: 7 quantity: 1 prorated: null created_at: null updated_at: null original_product: id: 20 name: Mediocre Granite Bench 758c53 products_price: id: 13 amount: '100.0' currency: USD duration: 1 interval: null interval_count: null products_variant: description: Quis asperiores et magnam. id: 13 name: Gorgeous Wool Hat variant 2d68 sku: W0CzXEyvCABstAiL ProductAttributes: title: Products description: Products type: object required: - id - workspace_id - name - default_variant_id properties: id: description: ID type: integer public_id: description: Product public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Product name type: string current_path: description: Current Path type: - string - 'null' archived: description: Archived type: - boolean - 'null' visible_in_store: description: Visible in store type: - boolean - 'null' visible_in_customer_center: description: Visible in customer center type: - boolean - 'null' image_id: description: Image type: - string - 'null' seo_title: description: SEO title type: - string - 'null' seo_description: description: SEO description type: - string - 'null' seo_image_id: description: SEO image type: - string - 'null' commissionable: description: Commissionable type: - boolean - 'null' image_ids: description: Images type: - array - 'null' default_variant_id: description: The ID of the default variant of the product type: integer variant_ids: description: Variant IDs type: - array - 'null' price_ids: description: Price IDs type: - array - 'null' tag_ids: description: >- Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s) type: - array - 'null' redirect_funnel_id: description: Redirect funnel type: - string - 'null' cancellation_funnel_url: description: Cancellation Funnel Url type: - string - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time variant_properties: description: Properties that are specific to the default variant of a product type: - array - 'null' items: title: Product Properties description: Properties type: object required: - id - name properties: id: description: ID type: integer name: description: Name type: string example: id: 22 public_id: UuQmoP workspace_id: 42 name: Synergistic Wool Knife 5d6055 current_path: null archived: false visible_in_store: true visible_in_customer_center: true image_id: null seo_title: Voluptatibus repudiandae sed iste. seo_description: Velit quos asperiores sint. seo_image_id: null commissionable: true image_ids: [] default_variant_id: 22 variant_ids: [] price_ids: [] tag_ids: [] redirect_funnel_id: null cancellation_funnel_url: null created_at: '2024-04-15T15:33:47.013Z' updated_at: '2024-04-15T15:33:47.013Z' variant_properties: - id: 22 name: Color ProductParameters: title: Products description: Products type: object required: - name properties: name: description: Product name type: string current_path: description: Current Path type: - string - 'null' visible_in_store: description: Visible in store type: - boolean - 'null' visible_in_customer_center: description: Visible in customer center type: - boolean - 'null' seo_title: description: SEO title type: - string - 'null' seo_description: description: SEO description type: - string - 'null' seo_image_id: description: SEO image type: - string - 'null' commissionable: description: Commissionable type: - boolean - 'null' image_ids: description: Images type: - array - 'null' variant_ids: description: Variant IDs type: - array - 'null' price_ids: description: Price IDs type: - array - 'null' redirect_funnel_id: description: Redirect funnel type: - string - 'null' cancellation_funnel_url: description: Cancellation Funnel Url type: - string - 'null' tag_ids: description: >- Any valid array, empty or with valid tag ids will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s) type: array items: type: integer variant_properties: description: The properties of the product's variants. e.g. 'Size', 'Color' etc. type: array items: type: object properties: id: description: The ID of the property, if updating the property type: integer name: description: The name of the property type: string example: name: Synergistic Wool Knife 5d6055 visible_in_store: true visible_in_customer_center: true seo_title: Voluptatibus repudiandae sed iste. seo_description: Velit quos asperiores sint. commissionable: true ProductsPriceAttributes: title: Prices description: Prices type: object required: - id - amount - currency - duration - interval - trial_interval - trial_duration - trial_amount - interval_count properties: id: description: ID type: integer public_id: description: Price public ID type: - string - 'null' variant_id: description: Variant type: - integer - 'null' name: description: Name type: - string - 'null' amount: description: Amount type: string cost: description: Cost type: - string - 'null' currency: description: Currency type: string duration: description: Duration type: integer interval: description: Interval type: string trial_interval: description: Trial interval type: string trial_duration: description: Trial duration type: string trial_amount: description: Trial Amount type: string setup_amount: description: Setup amount type: - string - 'null' self_cancel: description: Customer can cancel type: - boolean - 'null' self_upgrade: description: Customer can upgrade type: - boolean - 'null' self_downgrade: description: Customer can downgrade type: - boolean - 'null' self_reactivate: description: Customer can reactivate type: - boolean - 'null' interval_count: description: Interval count type: integer payment_type: description: Payment Type type: string enum: - one_time - subscription - payment_plan visible: description: Visible type: - boolean - 'null' compare_at_amount: description: Compare at amount type: - string - 'null' key: description: Key type: - string - 'null' archived: description: Archived type: - boolean - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 14 public_id: igQFRk variant_id: 14 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: null visible: true compare_at_amount: null key: null archived: false created_at: '2024-04-15T15:33:47.174Z' updated_at: '2024-04-15T15:33:47.174Z' ProductsPriceParameters: title: Prices description: Prices type: object required: - amount - currency - duration - interval - trial_interval - trial_duration - trial_amount - interval_count properties: name: description: Name type: - string - 'null' amount: description: Amount type: string cost: description: Cost type: - string - 'null' currency: description: Currency type: string duration: description: Duration type: integer interval: description: Interval type: string trial_interval: description: Trial interval type: string trial_duration: description: Trial duration type: string trial_amount: description: Trial Amount type: string setup_amount: description: Setup amount type: - string - 'null' self_cancel: description: Customer can cancel type: - boolean - 'null' self_upgrade: description: Customer can upgrade type: - boolean - 'null' self_downgrade: description: Customer can downgrade type: - boolean - 'null' self_reactivate: description: Customer can reactivate type: - boolean - 'null' interval_count: description: Interval count type: integer payment_type: description: Payment Type type: string enum: - one_time - subscription - payment_plan visible: description: Visible type: - boolean - 'null' compare_at_amount: description: Compare at amount type: - string - 'null' key: description: Key type: - string - 'null' archived: description: Archived type: - boolean - 'null' example: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_amount: '0.00' self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 visible: true ProductsVariantAttributes: title: Variants description: Variants type: object required: - id - product_id - name - product_type - weight_unit properties: description: description: Description type: - string - 'null' id: description: ID type: integer public_id: description: Variant public ID type: - string - 'null' product_id: description: Product ID type: integer name: description: Name type: string sku: description: SKU type: - string - 'null' product_type: description: Type type: string properties_value_ids: description: Properties values type: - array - 'null' minContains: 0 contains: type: string out_of_stock_sales: description: Out of stock sales type: - string - 'null' weight: description: Weight type: - number - 'null' weight_unit: description: Weight unit type: string height: description: Height type: - number - 'null' width: description: Width type: - number - 'null' length: description: Length type: - number - 'null' dimensions_unit: description: Dimensions unit type: - string - 'null' quantity: description: Quantity type: - integer - 'null' tag_ids: description: Tags type: - array - 'null' minContains: 0 contains: type: integer tax_category_id: description: Tax category ID type: - string - 'null' asset_ids: description: Assets type: - array - 'null' taxable: description: Taxable type: - string - 'null' track_quantity: description: Track Quantity type: - boolean - 'null' archived: description: Archived type: - boolean - 'null' visible: description: Is visible type: - boolean - 'null' price_ids: description: Price IDs type: - array - 'null' fulfillment_required: description: Fulfillment required type: - boolean - 'null' country_of_manufacture_id: description: Country of manufacture type: - string - 'null' image_ids: description: The images for the variant. type: - array - 'null' fulfillments_location_ids: description: The fulfillment locations for the variant. type: - array - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time default: description: Is this default variant type: - boolean - 'null' properties_values: description: The property values of the Variant. e.g. 'Large', 'Red' etc. type: - array - 'null' items: title: 'Translation missing: en.products/properties/values.api_title' description: Properties Values type: object required: [] properties: property_id: description: The ID of the property type: - integer - 'null' value: description: The value type: - string - 'null' example: description: Et repellat ullam corporis. id: 15 public_id: cKDoMk product_id: 24 name: Enormous Wooden Gloves variant d045 sku: TnGhoa6ZpD3Lpby9 product_type: physical properties_value_ids: - null out_of_stock_sales: null weight: '55.0' weight_unit: lb height: '71.0' width: '761.0' length: '84.0' dimensions_unit: inches quantity: 0 tag_ids: - 39 tax_category_id: null asset_ids: [] taxable: null track_quantity: false archived: false visible: true price_ids: [] fulfillment_required: false country_of_manufacture_id: null image_ids: [] fulfillments_location_ids: [] created_at: '2024-04-15T15:33:47.294Z' updated_at: '2024-04-15T15:33:47.294Z' default: false properties_values: - property_id: 15 value: Ochre ProductsVariantParameters: title: Variants description: Variants type: object required: - name - product_type - weight_unit properties: description: description: Description type: - string - 'null' name: description: Name type: string sku: description: SKU type: - string - 'null' product_type: description: Type type: string out_of_stock_sales: description: Out of stock sales type: - string - 'null' weight: description: Weight type: - number - 'null' weight_unit: description: Weight unit type: string height: description: Height type: - number - 'null' width: description: Width type: - number - 'null' length: description: Length type: - number - 'null' dimensions_unit: description: Dimensions unit type: - string - 'null' tax_category_id: description: Tax category ID type: - string - 'null' taxable: description: Taxable type: - string - 'null' track_quantity: description: Track Quantity type: - boolean - 'null' archived: description: Archived type: - boolean - 'null' visible: description: Is visible type: - boolean - 'null' fulfillment_required: description: Fulfillment required type: - boolean - 'null' country_of_manufacture_id: description: Country of manufacture type: - string - 'null' image_ids: description: The images for the variant. type: - array - 'null' fulfillments_location_ids: description: The fulfillment locations for the variant. type: - array - 'null' properties_values: description: The property values of the Variant. e.g. 'Large', 'Red' etc. type: array items: type: object properties: property_id: description: The ID of the property type: integer value: description: The value type: string example: description: Et repellat ullam corporis. name: Enormous Wooden Gloves variant d045 sku: TnGhoa6ZpD3Lpby9 product_type: physical weight: '55.0' weight_unit: lb height: '71.0' width: '761.0' length: '84.0' dimensions_unit: inches visible: true ProductsTagAttributes: title: Product Tags description: Product Tags type: object required: - id - workspace_id - name - color properties: id: description: Tag ID type: integer public_id: description: Tag public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Name type: string color: description: Color type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 40 public_id: XkwDCV workspace_id: 42 name: Example Tag color: lilac created_at: '2024-04-15T15:33:47.425Z' updated_at: '2024-04-15T15:33:47.425Z' ProductsTagParameters: title: Product Tags description: Product Tags type: object required: - name - color properties: name: description: Name type: string color: description: Color type: string example: name: Example Tag color: lilac ShippingLocationGroupAttributes: title: Location groups description: Location groups type: object required: - id - profile_id - name properties: id: description: Location group ID type: integer public_id: description: Location group public ID type: - string - 'null' profile_id: description: Profile ID type: integer name: description: Name type: string fulfillments_location_ids: description: Fulfillments Locations type: - array - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: GpjSCV profile_id: 1 name: Example Location Group fulfillments_location_ids: [] created_at: '2024-04-15T15:33:47.528Z' updated_at: '2024-04-15T15:33:47.528Z' ShippingPackageAttributes: title: Packages description: Packages type: object required: - id - package_type - height - width - length - distance_unit - name properties: id: description: Package ID type: integer public_id: description: Package public ID type: - string - 'null' package_type: description: Package Type type: string enum: - box - envelope - soft_package height: description: Height type: number width: description: Width type: number length: description: Length type: number distance_unit: description: Distance Unit type: string enum: - in - cm - ft - m - mm empty_weight: description: Empty Weight type: - string - 'null' weight: description: Weight type: - number - 'null' weight_unit: description: Weight Unit type: string enum: - lb - kg - g - oz default_package: description: Default Package type: - boolean - 'null' name: description: Name type: string token: description: Token type: - string - 'null' carrier: description: Carrier type: string enum: - fedex - ups - usps created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 1 public_id: JrGATq package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in empty_weight: null weight: '0.0' weight_unit: lb default_package: false name: Example Package token: null carrier: null created_at: '2024-04-15T15:33:47.621Z' updated_at: '2024-04-15T15:33:47.621Z' ShippingPackageParameters: title: Packages description: Packages type: object required: - package_type - height - width - length - distance_unit - name properties: package_type: description: Package Type type: string enum: - box - envelope - soft_package height: description: Height type: number width: description: Width type: number length: description: Length type: number distance_unit: description: Distance Unit type: string enum: - in - cm - ft - m - mm empty_weight: description: Empty Weight type: - string - 'null' weight: description: Weight type: - number - 'null' weight_unit: description: Weight Unit type: string enum: - lb - kg - g - oz default_package: description: Default Package type: - boolean - 'null' name: description: Name type: string carrier: description: Carrier type: string enum: - fedex - ups - usps example: package_type: box height: '4.0' width: '2.0' length: '2.0' distance_unit: in weight: '0.0' weight_unit: lb name: Example Package ShippingProfileAttributes: title: Profiles description: Profiles type: object required: - id - name properties: id: description: Profile ID type: integer public_id: description: Profile public ID type: - string - 'null' name: description: Name type: string variant_ids: description: Variant IDs type: - array - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 2 public_id: NkEavg name: Example Shipping Profile variant_ids: [] created_at: '2024-04-15T15:33:47.675Z' updated_at: '2024-04-15T15:33:47.675Z' ShippingProfileParameters: title: Profiles description: Profiles type: object required: - name properties: name: description: Name type: string variant_ids: description: Variant IDs type: - array - 'null' example: name: Example Shipping Profile ShippingRateAttributes: title: Rates description: Rates type: object required: - id - zone_id - price - price_currency - rates_name_id properties: description: description: Rate name type: - string - 'null' id: description: Rate ID type: integer public_id: description: Rate public ID type: - string - 'null' zone_id: description: Zone ID type: integer provider_name: description: Provider Name type: - string - 'null' price: description: Price type: string price_currency: description: Price Currency type: string rates_name_id: description: Rate name ID type: integer live_rates_provider: description: Live Rates Provider type: string enum: - Shippo created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: description: Example Shipping Rates Name id: 1 public_id: RgmnKA zone_id: 1 provider_name: Amb. Chantay Lind price: '10.00' price_currency: USD rates_name_id: 1 live_rates_provider: null created_at: '2024-04-15T15:33:47.795Z' updated_at: '2024-04-15T15:33:47.795Z' ShippingRateParameters: title: Rates description: Rates type: object required: - price - price_currency - rates_name_id properties: provider_name: description: Provider Name type: - string - 'null' price: description: Price type: string price_currency: description: Price Currency type: string rates_name_id: description: Rate name ID type: integer live_rates_provider: description: Live Rates Provider type: string enum: - Shippo example: provider_name: Amb. Chantay Lind price: '10.00' price_currency: USD rates_name_id: 1 ShippingRatesNameAttributes: title: Rate Names description: Rate Names type: object required: - id - workspace_id - name properties: id: description: Rate Name ID type: integer public_id: description: Rate Name public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Rate Name type: string created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' format: date-time example: id: 2 public_id: cbThrY workspace_id: 42 name: Example Shipping Rates Name created_at: '2024-04-15T15:33:47.848Z' updated_at: '2024-04-15T15:33:47.848Z' ShippingRatesNameParameters: title: Rate Names description: Rate Names type: object required: - name properties: name: description: Rate Name type: string example: name: Example Shipping Rates Name ShippingZoneAttributes: title: Zones description: Zones type: object required: - id - location_group_id - name properties: id: description: Zone ID type: integer public_id: description: Zone public ID type: - string - 'null' location_group_id: description: Location group ID type: integer name: description: Name type: string address_filter_id: description: Zone type: - string - 'null' region_ids: description: Region IDs type: - array - 'null' country_ids: description: Country IDs type: - array - 'null' includes_rest_of_world: description: Includes Rest of the World type: - boolean - 'null' created_at: description: Added type: - string - 'null' format: date-time updated_at: description: Updated type: - string - 'null' example: id: 2 public_id: iwQSFX location_group_id: 3 name: Ron Weimann address_filter_id: null region_ids: [] country_ids: [] includes_rest_of_world: false created_at: '2024-04-15T15:33:47.900Z' updated_at: null ShippingZoneParameters: title: Zones description: Zones type: object required: - name properties: name: description: Name type: string address_filter_id: description: Zone type: - string - 'null' region_ids: description: Region IDs type: - array - 'null' country_ids: description: Country IDs type: - array - 'null' includes_rest_of_world: description: Includes Rest of the World type: - boolean - 'null' example: name: Ron Weimann WebhooksOutgoingEndpointAttributes: title: Webhooks description: Webhooks type: object required: - id - workspace_id - url - name properties: id: description: Endpoint ID type: integer public_id: description: Endpoint public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer url: description: URL type: string name: description: Name type: string event_type_ids: description: Event types type: - array - 'null' minContains: 0 contains: type: string created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' example: id: 1 public_id: PsgzaT workspace_id: 42 url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified created_at: null updated_at: null WebhooksOutgoingEndpointParameters: title: Webhooks description: Webhooks type: object required: - url - name properties: url: description: URL type: string name: description: Name type: string event_type_ids: description: >- Represents the event types to which the webhook is subscribed. On create one or more valid `event_type_ids` are required. See the Webhook Event Types guide for details. On update to remove one `event_type_id` pass an array of all current `event_type_ids` less the one to be removed. On update to remove all `event_type_ids` pass an empty array. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. example: url: https://example.com/some-endpoint-url name: Example Endpoint event_type_ids: - contact.identified WebhooksOutgoingEventAttributes: title: Webhooks Events description: Webhooks Events type: object required: - id - workspace_id - subject_id properties: id: description: Event ID type: string public_id: description: Event public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer uuid: description: Event UUID type: - string - 'null' event_type_id: description: Event Type type: - string - 'null' subject_id: description: Subject ID type: integer subject_type: description: Subject Type type: - string - 'null' data: description: Object Data type: - object - 'null' properties: example: description: >- { "event_type_name": "order.created", "payload": { "order_id": 123, "order_number": "12345" } } type: string created_at: description: Happened At type: - string - 'null' format: date-time example: id: null public_id: PVylqF workspace_id: 42 uuid: 548813de13bddb49c61e959971b8436f event_type_id: contact.identified subject_id: 15 subject_type: Contact data: example: testing created_at: '2024-03-15T15:33:48.093Z' FulfillmentsLocationAttributes: title: Locations description: Locations type: object required: - id - workspace_id - name - address_name - email_address - address properties: id: description: Location ID type: integer public_id: description: Public ID type: - string - 'null' workspace_id: description: Workspace ID type: integer name: description: Location name type: string address_name: description: Address name type: string email_address: description: Email address type: string phone_number: description: Phone number type: - string - 'null' sort_order: description: Sort order type: - integer - 'null' archived: description: Archived type: - boolean - 'null' external_app: description: External app type: - boolean - 'null' created_at: description: Added type: - string - 'null' updated_at: description: Updated type: - string - 'null' address: title: Locations description: Locations type: object required: [] properties: address_one: description: Address line 1 type: - string - 'null' address_two: description: Address line 2 type: - string - 'null' city: description: City type: - string - 'null' region: description: Region type: - string - 'null' country: description: Country type: - string - 'null' postal_code: description: Postal code type: - string - 'null' example: id: 2 public_id: TaevRs workspace_id: 42 name: Example Location address_name: Example Address email_address: myemail1713195228@example.com phone_number: (123)-555-4567 sort_order: 1 archived: false external_app: true created_at: null updated_at: null address: address_one: 3443 W. Bavaria St. address_two: Suite 100 city: Eagle region: Idaho country: US postal_code: '83616' FulfillmentsLocationParameters: title: Locations description: Locations type: object required: - name - address_name - email_address properties: name: description: Location name type: string address_name: description: Address name type: string email_address: description: Email address type: string phone_number: description: Phone number type: - string - 'null' archived: description: Archived type: - boolean - 'null' external_app: description: >- Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address. type: boolean address: type: object properties: address_one: description: The first line of the address type: string address_two: description: The second line of the address type: string city: description: The city type: string region: description: The state or province type: string country: description: The country (ISO2 code) type: string postal_code: description: The postal code type: string example: name: Example Location address_name: Example Address email_address: myemail1713195228@example.com phone_number: (123)-555-4567 TeamUpdateTeamByIdRequest: type: object properties: team: type: object $ref: '#/components/schemas/TeamParameters' UserUpdateSingleUserRequest: type: object properties: user: type: object $ref: '#/components/schemas/UserParameters' WorkspaceAddNewRequest: type: object properties: workspace: type: object $ref: '#/components/schemas/WorkspaceParameters' WorkspaceUpdateRequest: type: object properties: workspace: type: object $ref: '#/components/schemas/WorkspaceParameters' ContactCreateNewContactRequest: type: object properties: contact: type: object $ref: '#/components/schemas/ContactParameters' ContactUpdateContactByIdRequest: type: object properties: contact: type: object $ref: '#/components/schemas/ContactParameters' ContactUpsertRequest: type: object properties: contact: title: Contacts description: Contacts type: object required: - email_address properties: email_address: description: Email address type: - string first_name: description: First name type: - string - 'null' last_name: description: Last name type: - string - 'null' phone_number: description: Phone number type: - string - 'null' time_zone: description: Time zone type: - string - 'null' fb_url: description: Facebook URL type: - string - 'null' twitter_url: description: Twitter URL type: - string - 'null' instagram_url: description: Instagram URL type: - string - 'null' linkedin_url: description: Linkedin URL type: - string - 'null' website_url: description: Website URL type: - string - 'null' tag_ids: description: >- Tag IDs - An empty array is ignored here. If you wish to remove all tags for a Contact, use the `Update Contact` endpoint. - A non-empty array overwrites the existing array. - To avoid losing existing tags, first use the `Fetch Contact` endpoint then be sure to include the existing tags in your payload along with any new addition(s) type: array items: properties: id: description: Tag ID type: string example: contact: email_address: test-637ece40bee994560adb@example.com first_name: Emerald last_name: Skiles phone_number: 1-555-069-2678 time_zone: Pacific Time (US & Canada) fb_url: https://fb.com/url twitter_url: https://x.com/url instagram_url: https://ig.com/url linkedin_url: https://li.com/url website_url: https://example.com/ tag_ids: - '1' - '2' ContactsAppliedTagCreateAppliedTagRequest: type: object properties: contacts_applied_tag: type: object $ref: '#/components/schemas/ContactsAppliedTagParameters' ContactsTagCreateNewTagRequest: type: object properties: contacts_tag: type: object $ref: '#/components/schemas/ContactsTagParameters' ContactsTagUpdateSpecificTagRequest: type: object properties: contacts_tag: type: object $ref: '#/components/schemas/ContactsTagParameters' CoursesEnrollmentCreateNewEnrollmentRequest: type: object properties: courses_enrollment: type: object $ref: '#/components/schemas/CoursesEnrollmentParameters' CoursesEnrollmentUpdateSpecificEnrollmentRequest: type: object properties: courses_enrollment: type: object $ref: '#/components/schemas/CoursesEnrollmentParameters' CoursesSectionUpdateSectionByIdRequest: type: object properties: courses_section: type: object $ref: '#/components/schemas/CoursesSectionParameters' CoursesLessonUpdateLessonByIdRequest: type: object properties: courses_lesson: type: object $ref: '#/components/schemas/CoursesLessonParameters' FormCreateNewFormRequest: type: object properties: form: type: object $ref: '#/components/schemas/FormParameters' FormUpdateFormByIdRequest: type: object properties: form: type: object $ref: '#/components/schemas/FormParameters' FormsFieldSetCreateNewFieldSetRequest: type: object properties: forms_field_set: type: object $ref: '#/components/schemas/FormsFieldSetParameters' FormsFieldSetUpdateFieldSetByIdRequest: type: object properties: forms_field_set: type: object $ref: '#/components/schemas/FormsFieldSetParameters' FormsFieldAddNewFieldRequest: type: object properties: forms_field: type: object $ref: '#/components/schemas/FormsFieldParameters' FormsFieldUpdateFieldByIdRequest: type: object properties: forms_field: type: object $ref: '#/components/schemas/FormsFieldParameters' FormsFieldsOptionCreateNewFieldOptionRequest: type: object properties: forms_fields_option: type: object $ref: '#/components/schemas/FormsFieldsOptionParameters' FormsFieldsOptionUpdateFieldOptionRequest: type: object properties: forms_fields_option: type: object $ref: '#/components/schemas/FormsFieldsOptionParameters' FormsSubmissionCreateNewSubmissionRequest: type: object properties: forms_submission: type: object $ref: '#/components/schemas/FormsSubmissionParameters' FormsSubmissionUpdateSubmissionRequest: type: object properties: forms_submission: type: object $ref: '#/components/schemas/FormsSubmissionParameters' FormsSubmissionsAnswerAddNewAnswerRequest: type: object properties: forms_submissions_answer: type: object $ref: '#/components/schemas/FormsSubmissionsAnswerParameters' FormsSubmissionsAnswerUpdateAnswerRequest: type: object properties: forms_submissions_answer: type: object $ref: '#/components/schemas/FormsSubmissionsAnswerParameters' FulfillmentCreateRequest: type: object properties: fulfillment: type: object $ref: '#/components/schemas/FulfillmentParameters' FulfillmentUpdateByIdRequest: type: object properties: fulfillment: title: Fulfillment description: Fulfillment type: object $ref: '#/components/schemas/FulfillmentParameters' properties: tracking_url: description: Tracking URL type: - string - 'null' shipping_provider: description: Shipping Provider type: - string - 'null' tracking_code: description: Tracking Code type: - string - 'null' notify_customer: description: >- Send an email to the customer about the order having been fulfilled. This will send an email each time you pass it with the value of true. type: boolean default: false example: tracking_url: https://usps.com/track/1234567890 shipping_provider: USPS tracking_code: '1234567890' notify_customer: true FulfillmentsLocationCreateNewLocationRequest: type: object properties: fulfillments_location: type: object $ref: '#/components/schemas/FulfillmentsLocationParameters' FulfillmentsLocationUpdateByIdRequest: type: object properties: fulfillments_location: type: object $ref: '#/components/schemas/FulfillmentsLocationParameters' ImageCreateRequest: type: object properties: image: type: object $ref: '#/components/schemas/ImageParameters' ImageUpdateByIdRequest: type: object properties: image: type: object $ref: '#/components/schemas/ImageParameters' OrderUpdateSpecificRequest: type: object properties: order: type: object $ref: '#/components/schemas/OrderParameters' OrdersAppliedTagCreateAppliedTagRequest: type: object properties: orders_applied_tag: type: object $ref: '#/components/schemas/OrdersAppliedTagParameters' OrdersTagCreateNewTagRequest: type: object properties: orders_tag: type: object $ref: '#/components/schemas/OrdersTagParameters' OrdersTagUpdateSpecificOrderTagRequest: type: object properties: orders_tag: type: object $ref: '#/components/schemas/OrdersTagParameters' ProductAddNewToWorkspaceRequest: type: object properties: product: type: object $ref: '#/components/schemas/ProductParameters' ProductUpdateForWorkspaceRequest: type: object properties: product: type: object $ref: '#/components/schemas/ProductParameters' ProductsPriceCreateNewPriceRequest: type: object properties: products_price: type: object required: - id - name - amount $ref: '#/components/schemas/ProductsPriceParameters' ProductsPriceUpdateSinglePriceRequest: type: object properties: products_price: type: object $ref: '#/components/schemas/ProductsPriceParameters' ProductsVariantCreateNewVariantRequest: type: object properties: products_variant: type: object $ref: '#/components/schemas/ProductsVariantParameters' ProductsVariantUpdateSingleRequest: type: object properties: products_variant: type: object $ref: '#/components/schemas/ProductsVariantParameters' ProductsTagCreateNewTagRequest: type: object properties: products_tag: type: object $ref: '#/components/schemas/ProductsTagParameters' ProductsTagUpdateTagByIdRequest: type: object properties: products_tag: type: object $ref: '#/components/schemas/ProductsTagParameters' ShippingPackageAddToWorkspaceRequest: type: object properties: shipping_package: type: object $ref: '#/components/schemas/ShippingPackageParameters' ShippingPackageUpdateForWorkspaceRequest: type: object properties: shipping_package: type: object $ref: '#/components/schemas/ShippingPackageParameters' ShippingProfileCreateNewRequest: type: object properties: shipping_profile: type: object $ref: '#/components/schemas/ShippingProfileParameters' ShippingProfileUpdateForWorkspaceRequest: type: object properties: shipping_profile: type: object $ref: '#/components/schemas/ShippingProfileParameters' ShippingRateCreateRateForZoneRequest: type: object properties: shipping_rate: type: object $ref: '#/components/schemas/ShippingRateParameters' ShippingRateUpdateRateForZoneRequest: type: object properties: shipping_rate: type: object $ref: '#/components/schemas/ShippingRateParameters' ShippingZoneAddNewZoneRequest: type: object properties: shipping_zone: type: object $ref: '#/components/schemas/ShippingZoneParameters' ShippingZoneUpdateZoneByIdRequest: type: object properties: shipping_zone: type: object $ref: '#/components/schemas/ShippingZoneParameters' ShippingRatesNameCreateNewRateNameRequest: type: object properties: shipping_rates_name: type: object $ref: '#/components/schemas/ShippingRatesNameParameters' ShippingRatesNameUpdateNameRequest: type: object properties: shipping_rates_name: type: object $ref: '#/components/schemas/ShippingRatesNameParameters' WebhooksOutgoingEndpointCreateNewRequest: type: object properties: webhooks_outgoing_endpoint: type: object $ref: '#/components/schemas/WebhooksOutgoingEndpointParameters' WebhooksOutgoingEndpointUpdateEndpointRequest: type: object properties: webhooks_outgoing_endpoint: type: object $ref: '#/components/schemas/WebhooksOutgoingEndpointParameters' TeamGetAllResponse: type: array items: $ref: '#/components/schemas/TeamAttributes' TeamGetAll401Response: type: object properties: error: type: string TeamGetSingleResponse: type: object properties: error: type: string TeamGetSingle401Response: type: object properties: error: type: string TeamGetSingle404Response: type: object properties: error: type: string TeamUpdateTeamByIdResponse: type: object properties: error: type: string TeamUpdateTeamById401Response: type: object properties: error: type: string TeamUpdateTeamById404Response: type: object properties: error: type: string UserListCurrentAccountUsersResponse: type: array items: $ref: '#/components/schemas/UserAttributes' UserListCurrentAccountUsers401Response: type: object properties: error: type: string UserGetSingleResponse: type: object properties: error: type: string UserGetSingle404Response: type: object properties: error: type: string UserUpdateSingleUserResponse: type: object properties: error: type: string UserUpdateSingleUser404Response: type: object properties: error: type: string WorkspaceListWorkspacesResponse: type: array items: $ref: '#/components/schemas/WorkspaceAttributes' WorkspaceListWorkspaces401Response: type: object properties: error: type: string WorkspaceListWorkspaces404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string WorkspaceAddNewResponse: type: object properties: error: type: string WorkspaceAddNew401Response: type: object properties: error: type: string WorkspaceGetByIdResponse: type: object properties: error: type: string WorkspaceGetById404Response: type: object properties: error: type: string WorkspaceUpdateResponse: type: object properties: error: type: string WorkspaceUpdate401Response: type: object properties: error: type: string WorkspaceUpdate404Response: type: object properties: error: type: string ContactListForWorkspaceResponse: type: array items: $ref: '#/components/schemas/ContactAttributes' ContactListForWorkspace401Response: type: object properties: error: type: string ContactListForWorkspace404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ContactCreateNewContactResponse: type: object properties: error: type: string ContactCreateNewContact401Response: type: object properties: error: type: string ContactRemoveByIdResponse: type: object properties: error: type: string ContactRemoveById404Response: type: object properties: error: type: string ContactGetContactByIdResponse: type: object properties: error: type: string ContactGetContactById404Response: type: object properties: error: type: string ContactUpdateContactByIdResponse: type: object properties: error: type: string ContactUpdateContactById401Response: type: object properties: error: type: string ContactUpdateContactById404Response: type: object properties: error: type: string ContactUpsertResponse: type: array items: $ref: '#/components/schemas/ContactAttributes' ContactUpsert201Response: type: array items: $ref: '#/components/schemas/ContactAttributes' ContactsAppliedTagListResponse: type: array items: $ref: '#/components/schemas/ContactsAppliedTagAttributes' ContactsAppliedTagList401Response: type: object properties: error: type: string ContactsAppliedTagList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ContactsAppliedTagCreateAppliedTagResponse: type: object properties: error: type: string ContactsAppliedTagCreateAppliedTag401Response: type: object properties: error: type: string ContactsAppliedTagRemoveByIdResponse: type: object properties: error: type: string ContactsAppliedTagRemoveById404Response: type: object properties: error: type: string ContactsAppliedTagGetForContactResponse: type: object properties: error: type: string ContactsAppliedTagGetForContact404Response: type: object properties: error: type: string ContactsTagListResponse: type: array items: $ref: '#/components/schemas/ContactsTagAttributes' ContactsTagList401Response: type: object properties: error: type: string ContactsTagList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ContactsTagCreateNewTagResponse: type: object properties: error: type: string ContactsTagCreateNewTag401Response: type: object properties: error: type: string ContactsTagRemoveResponse: type: object properties: error: type: string ContactsTagRemove404Response: type: object properties: error: type: string ContactsTagGetSingleResponse: type: object properties: error: type: string ContactsTagGetSingle404Response: type: object properties: error: type: string ContactsTagUpdateSpecificTagResponse: type: object properties: error: type: string ContactsTagUpdateSpecificTag401Response: type: object properties: error: type: string ContactsTagUpdateSpecificTag404Response: type: object properties: error: type: string CourseListForWorkspaceResponse: type: array items: $ref: '#/components/schemas/CourseAttributes' CourseListForWorkspace401Response: type: object properties: error: type: string CourseListForWorkspace404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string CourseGetByIdResponse: type: object properties: error: type: string CourseGetById404Response: type: object properties: error: type: string CoursesEnrollmentListResponse: type: array items: $ref: '#/components/schemas/CoursesEnrollmentAttributes' CoursesEnrollmentList401Response: type: object properties: error: type: string CoursesEnrollmentList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string CoursesEnrollmentCreateNewEnrollmentResponse: type: object properties: error: type: string CoursesEnrollmentCreateNewEnrollment401Response: type: object properties: error: type: string CoursesEnrollmentGetByIdResponse: type: object properties: error: type: string CoursesEnrollmentGetById404Response: type: object properties: error: type: string CoursesEnrollmentUpdateSpecificEnrollmentResponse: type: object properties: error: type: string CoursesEnrollmentUpdateSpecificEnrollment401Response: type: object properties: error: type: string CoursesEnrollmentUpdateSpecificEnrollment404Response: type: object properties: error: type: string CoursesSectionListSectionsResponse: type: array items: $ref: '#/components/schemas/CoursesSectionAttributes' CoursesSectionListSections401Response: type: object properties: error: type: string CoursesSectionListSections404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string CoursesSectionGetSectionResponse: type: object properties: error: type: string CoursesSectionGetSection404Response: type: object properties: error: type: string CoursesSectionUpdateSectionByIdResponse: type: object properties: error: type: string CoursesSectionUpdateSectionById401Response: type: object properties: error: type: string CoursesSectionUpdateSectionById404Response: type: object properties: error: type: string CoursesLessonListLessonsResponse: type: array items: $ref: '#/components/schemas/CoursesLessonAttributes' CoursesLessonListLessons401Response: type: object properties: error: type: string CoursesLessonListLessons404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string CoursesLessonGetByIdResponse: type: object properties: error: type: string CoursesLessonGetById404Response: type: object properties: error: type: string CoursesLessonUpdateLessonByIdResponse: type: object properties: error: type: string CoursesLessonUpdateLessonById401Response: type: object properties: error: type: string CoursesLessonUpdateLessonById404Response: type: object properties: error: type: string FormListWorkspaceFormsResponse: type: array items: $ref: '#/components/schemas/FormAttributes' FormListWorkspaceForms401Response: type: object properties: error: type: string FormListWorkspaceForms404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormCreateNewFormResponse: type: object properties: error: type: string FormCreateNewForm401Response: type: object properties: error: type: string FormRemoveResponse: type: object properties: error: type: string FormRemove404Response: type: object properties: error: type: string FormGetFormResponse: type: object properties: error: type: string FormGetForm404Response: type: object properties: error: type: string FormUpdateFormByIdResponse: type: object properties: error: type: string FormUpdateFormById401Response: type: object properties: error: type: string FormUpdateFormById404Response: type: object properties: error: type: string FormsFieldSetListResponse: type: array items: $ref: '#/components/schemas/FormsFieldSetAttributes' FormsFieldSetList401Response: type: object properties: error: type: string FormsFieldSetList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormsFieldSetCreateNewFieldSetResponse: type: object properties: error: type: string FormsFieldSetCreateNewFieldSet401Response: type: object properties: error: type: string FormsFieldSetRemoveResponse: type: object properties: error: type: string FormsFieldSetRemove404Response: type: object properties: error: type: string FormsFieldSetGetFieldSetResponse: type: object properties: error: type: string FormsFieldSetGetFieldSet404Response: type: object properties: error: type: string FormsFieldSetUpdateFieldSetByIdResponse: type: object properties: error: type: string FormsFieldSetUpdateFieldSetById401Response: type: object properties: error: type: string FormsFieldSetUpdateFieldSetById404Response: type: object properties: error: type: string FormsFieldListFieldsForFieldSetResponse: type: array items: $ref: '#/components/schemas/FormsFieldAttributes' FormsFieldListFieldsForFieldSet401Response: type: object properties: error: type: string FormsFieldListFieldsForFieldSet404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormsFieldAddNewFieldResponse: type: object properties: error: type: string FormsFieldAddNewField401Response: type: object properties: error: type: string FormsFieldRemoveFieldResponse: type: object properties: error: type: string FormsFieldRemoveField404Response: type: object properties: error: type: string FormsFieldGetFieldResponse: type: object properties: error: type: string FormsFieldGetField404Response: type: object properties: error: type: string FormsFieldUpdateFieldByIdResponse: type: object properties: error: type: string FormsFieldUpdateFieldById401Response: type: object properties: error: type: string FormsFieldUpdateFieldById404Response: type: object properties: error: type: string FormsFieldsOptionListResponse: type: array items: $ref: '#/components/schemas/FormsFieldsOptionAttributes' FormsFieldsOptionList401Response: type: object properties: error: type: string FormsFieldsOptionList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormsFieldsOptionCreateNewFieldOptionResponse: type: object properties: error: type: string FormsFieldsOptionCreateNewFieldOption401Response: type: object properties: error: type: string FormsFieldsOptionDeleteOptionForFieldResponse: type: object properties: error: type: string FormsFieldsOptionDeleteOptionForField404Response: type: object properties: error: type: string FormsFieldsOptionGetFieldOptionResponse: type: object properties: error: type: string FormsFieldsOptionGetFieldOption404Response: type: object properties: error: type: string FormsFieldsOptionUpdateFieldOptionResponse: type: object properties: error: type: string FormsFieldsOptionUpdateFieldOption401Response: type: object properties: error: type: string FormsFieldsOptionUpdateFieldOption404Response: type: object properties: error: type: string FormsSubmissionListResponse: type: array items: $ref: '#/components/schemas/FormsSubmissionAttributes' FormsSubmissionList401Response: type: object properties: error: type: string FormsSubmissionList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormsSubmissionCreateNewSubmissionResponse: type: object properties: error: type: string FormsSubmissionCreateNewSubmission401Response: type: object properties: error: type: string FormsSubmissionRemoveResponse: type: object properties: error: type: string FormsSubmissionRemove404Response: type: object properties: error: type: string FormsSubmissionGetByIdResponse: type: object properties: error: type: string FormsSubmissionGetById404Response: type: object properties: error: type: string FormsSubmissionUpdateSubmissionResponse: type: object properties: error: type: string FormsSubmissionUpdateSubmission401Response: type: object properties: error: type: string FormsSubmissionUpdateSubmission404Response: type: object properties: error: type: string FormsSubmissionsAnswerListResponse: type: array items: $ref: '#/components/schemas/FormsSubmissionsAnswerAttributes' FormsSubmissionsAnswerList401Response: type: object properties: error: type: string FormsSubmissionsAnswerList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormsSubmissionsAnswerAddNewAnswerResponse: type: object properties: error: type: string FormsSubmissionsAnswerAddNewAnswer401Response: type: object properties: error: type: string FormsSubmissionsAnswerRemoveByIdResponse: type: object properties: error: type: string FormsSubmissionsAnswerRemoveById404Response: type: object properties: error: type: string FormsSubmissionsAnswerGetResponse: type: object properties: error: type: string FormsSubmissionsAnswerGet404Response: type: object properties: error: type: string FormsSubmissionsAnswerUpdateAnswerResponse: type: object properties: error: type: string FormsSubmissionsAnswerUpdateAnswer401Response: type: object properties: error: type: string FormsSubmissionsAnswerUpdateAnswer404Response: type: object properties: error: type: string FormSubmissionListSubmissionsResponse: type: array items: $ref: '#/components/schemas/FormSubmissionAttributes' FormSubmissionListSubmissions401Response: type: object properties: error: type: string FormSubmissionListSubmissions404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FormSubmissionGetSubmissionResponse: type: object properties: error: type: string FormSubmissionGetSubmission404Response: type: object properties: error: type: string FulfillmentListResponse: type: array items: $ref: '#/components/schemas/FulfillmentAttributes' FulfillmentList401Response: type: object properties: error: type: string FulfillmentList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FulfillmentCreateResponse: type: object properties: error: type: string FulfillmentCreate401Response: type: object properties: error: type: string FulfillmentGetByIdResponse: type: object properties: error: type: string FulfillmentGetById404Response: type: object properties: error: type: string FulfillmentUpdateByIdResponse: type: object properties: error: type: string FulfillmentUpdateById401Response: type: object properties: error: type: string FulfillmentUpdateById404Response: type: object properties: error: type: string FulfillmentsLocationListResponse: type: array items: $ref: '#/components/schemas/FulfillmentsLocationAttributes' FulfillmentsLocationList401Response: type: object properties: error: type: string FulfillmentsLocationList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string FulfillmentsLocationCreateNewLocationResponse: type: object properties: error: type: string FulfillmentsLocationCreateNewLocation401Response: type: object properties: error: type: string FulfillmentsLocationRemoveByIdResponse: type: object properties: error: type: string FulfillmentsLocationRemoveById404Response: type: object properties: error: type: string FulfillmentsLocationGetByIdResponse: type: object properties: error: type: string FulfillmentsLocationGetById404Response: type: object properties: error: type: string FulfillmentsLocationUpdateByIdResponse: type: object properties: error: type: string FulfillmentsLocationUpdateById401Response: type: object properties: error: type: string FulfillmentsLocationUpdateById404Response: type: object properties: error: type: string ImageListResponse: type: array items: $ref: '#/components/schemas/ImageAttributes' ImageList401Response: type: object properties: error: type: string ImageList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ImageCreateResponse: type: object properties: error: type: string ImageCreate401Response: type: object properties: error: type: string ImageRemoveByIdResponse: type: object properties: error: type: string ImageRemoveById404Response: type: object properties: error: type: string ImageGetByIdResponse: type: object properties: error: type: string ImageGetById404Response: type: object properties: error: type: string ImageUpdateByIdResponse: type: object properties: error: type: string ImageUpdateById401Response: type: object properties: error: type: string ImageUpdateById404Response: type: object properties: error: type: string OrderListOrdersResponse: type: array items: $ref: '#/components/schemas/OrderAttributes' OrderListOrders401Response: type: object properties: error: type: string OrderListOrders404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrderGetSingleResponse: type: object properties: error: type: string OrderGetSingle404Response: type: object properties: error: type: string OrderUpdateSpecificResponse: type: object properties: error: type: string OrderUpdateSpecific401Response: type: object properties: error: type: string OrderUpdateSpecific404Response: type: object properties: error: type: string OrdersInvoicesRestockListRestocksResponse: type: array items: title: Restocks description: Restocks type: object required: - id - workspace_id - contact_id - status - included_invoices_line_items - updated_at - created_at properties: id: description: Restock ID type: integer public_id: description: Public Restock ID type: - string - 'null' workspace_id: description: Workspace ID type: integer contact_id: description: Contact ID type: integer status: description: Status type: string enum: - cancelled - restocked created_at: description: Created At Date type: - string - 'null' format: date-time updated_at: description: Updated At Date type: - string - 'null' format: date-time included_invoices_line_items: description: Included order invoices line items type: - array - 'null' items: title: Included Orders Invoices Line Items description: Included Orders Invoices Line Item type: object required: - id - fulfillment_id - quantity - invoices_line_item_id properties: id: description: Included Orders Line Item ID type: integer public_id: description: Public ID type: - string - 'null' fulfillment_id: description: Restock ID type: integer quantity: description: Quantity type: integer invoices_line_item_id: description: Invoices Line Item type: integer example: id: 1 public_id: lDUzwt workspace_id: 42 contact_id: 6 status: restocked created_at: '2024-02-07T13:24:59.204Z' updated_at: '2024-02-07T13:24:59.204Z' included_invoices_line_items: - id: 1 public_id: BegDsZ fulfillment_id: 1 quantity: 1 invoices_line_item_id: 2 OrdersInvoicesRestockListRestocks401Response: type: object properties: error: type: string OrdersInvoicesRestockListRestocks404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersInvoicesRestockGetRestockResponse: title: Restock description: Restock type: object required: - id - workspace_id - contact_id - status - updated_at - created_at properties: id: description: Restock type: integer public_id: description: Public Restock ID type: - string - 'null' workspace_id: description: Workspace ID type: integer contact_id: description: Contact ID type: integer status: description: Status type: string enum: - cancelled - restocked created_at: description: Created At Date type: - string - 'null' format: date-time updated_at: description: Updated At Date type: - string - 'null' format: date-time included_invoices_line_items: description: Included Order Invoices Line Items type: - array - 'null' items: title: Included Orders Invoices Line Items description: Included Orders Invoices Line Item type: object required: - id - fulfillment_id - quantity - invoices_line_item_id - included_invoices_line_items - created_at - updated_at properties: id: description: Included Orders Line Item ID type: integer public_id: description: Public ID type: - string - 'null' fulfillment_id: description: Restock ID type: integer quantity: description: Quantity type: integer invoices_line_item_id: description: Invoices Line Item type: integer example: id: 1 public_id: lDUzwt workspace_id: 42 contact_id: 6 status: restocked created_at: '2024-02-07T13:24:59.204Z' updated_at: '2024-02-07T13:24:59.204Z' included_invoices_line_items: - id: 1 public_id: BegDsZ fulfillment_id: 1 quantity: 1 invoices_line_item_id: 2 OrdersInvoicesRestockGetRestock401Response: type: object properties: error: type: string OrdersInvoicesRestockGetRestock404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersAppliedTagListResponse: type: array items: $ref: '#/components/schemas/OrdersAppliedTagAttributes' OrdersAppliedTagList401Response: type: object properties: error: type: string OrdersAppliedTagList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersAppliedTagCreateAppliedTagResponse: type: object properties: error: type: string OrdersAppliedTagCreateAppliedTag401Response: type: object properties: error: type: string OrdersAppliedTagRemoveByIdResponse: type: object properties: error: type: string OrdersAppliedTagRemoveById404Response: type: object properties: error: type: string OrdersAppliedTagGetResponse: type: object properties: error: type: string OrdersAppliedTagGet404Response: type: object properties: error: type: string OrdersInvoiceListForOrderResponse: type: array items: $ref: '#/components/schemas/OrdersInvoiceAttributes' OrdersInvoiceListForOrder401Response: type: object properties: error: type: string OrdersInvoiceListForOrder404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersInvoiceGetForOrderResponse: type: object properties: error: type: string OrdersInvoiceGetForOrder404Response: type: object properties: error: type: string OrdersTransactionGetListResponse: type: array items: $ref: '#/components/schemas/OrdersTransactionAttributes' OrdersTransactionGetList401Response: type: object properties: error: type: string OrdersTransactionGetList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersTransactionGetByIdResponse: type: object properties: error: type: string OrdersTransactionGetById404Response: type: object properties: error: type: string OrdersTagListResponse: type: array items: $ref: '#/components/schemas/OrdersTagAttributes' OrdersTagList401Response: type: object properties: error: type: string OrdersTagList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string OrdersTagCreateNewTagResponse: type: object properties: error: type: string OrdersTagCreateNewTag401Response: type: object properties: error: type: string OrdersTagRemoveResponse: type: object properties: error: type: string OrdersTagRemove404Response: type: object properties: error: type: string OrdersTagGetSingleResponse: type: object properties: error: type: string OrdersTagGetSingle404Response: type: object properties: error: type: string OrdersTagUpdateSpecificOrderTagResponse: type: object properties: error: type: string OrdersTagUpdateSpecificOrderTag401Response: type: object properties: error: type: string OrdersTagUpdateSpecificOrderTag404Response: type: object properties: error: type: string ProductListForWorkspaceResponse: type: array items: $ref: '#/components/schemas/ProductAttributes' ProductListForWorkspace401Response: type: object properties: error: type: string ProductListForWorkspace404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ProductAddNewToWorkspaceResponse: type: object properties: error: type: string ProductAddNewToWorkspace401Response: type: object properties: error: type: string ProductGetForWorkspaceResponse: type: object properties: error: type: string ProductGetForWorkspace404Response: type: object properties: error: type: string ProductUpdateForWorkspaceResponse: type: object properties: error: type: string ProductUpdateForWorkspace401Response: type: object properties: error: type: string ProductUpdateForWorkspace404Response: type: object properties: error: type: string ProductsPriceCreateNewPriceResponse: type: object properties: error: type: string ProductsPriceCreateNewPrice401Response: type: object properties: error: type: string ProductsPriceListForVariantResponse: type: array items: $ref: '#/components/schemas/ProductsPriceAttributes' ProductsPriceListForVariant401Response: type: object properties: error: type: string ProductsPriceListForVariant404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ProductsPriceGetSinglePriceResponse: type: object properties: error: type: string ProductsPriceGetSinglePrice404Response: type: object properties: error: type: string ProductsPriceUpdateSinglePriceResponse: type: object properties: error: type: string ProductsPriceUpdateSinglePrice401Response: type: object properties: error: type: string ProductsPriceUpdateSinglePrice404Response: type: object properties: error: type: string ProductsVariantListResponse: type: array items: $ref: '#/components/schemas/ProductsVariantAttributes' ProductsVariantList401Response: type: object properties: error: type: string ProductsVariantList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ProductsVariantCreateNewVariantResponse: type: object properties: error: type: string ProductsVariantCreateNewVariant401Response: type: object properties: error: type: string ProductsVariantGetSingleResponse: type: object properties: error: type: string ProductsVariantGetSingle404Response: type: object properties: error: type: string ProductsVariantUpdateSingleResponse: type: object properties: error: type: string ProductsVariantUpdateSingle401Response: type: object properties: error: type: string ProductsVariantUpdateSingle404Response: type: object properties: error: type: string ProductsTagListResponse: type: array items: $ref: '#/components/schemas/ProductsTagAttributes' ProductsTagList401Response: type: object properties: error: type: string ProductsTagList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ProductsTagCreateNewTagResponse: type: object properties: error: type: string ProductsTagCreateNewTag401Response: type: object properties: error: type: string ProductsTagDeleteTagByIdResponse: type: object properties: error: type: string ProductsTagDeleteTagById404Response: type: object properties: error: type: string ProductsTagGetTagByIdResponse: type: object properties: error: type: string ProductsTagGetTagById404Response: type: object properties: error: type: string ProductsTagUpdateTagByIdResponse: type: object properties: error: type: string ProductsTagUpdateTagById401Response: type: object properties: error: type: string ProductsTagUpdateTagById404Response: type: object properties: error: type: string ShippingLocationGroupListResponse: type: array items: $ref: '#/components/schemas/ShippingLocationGroupAttributes' ShippingLocationGroupList401Response: type: object properties: error: type: string ShippingLocationGroupList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingLocationGroupGetProfileLocationGroupResponse: type: object properties: error: type: string ShippingLocationGroupGetProfileLocationGroup404Response: type: object properties: error: type: string ShippingPackageListForWorkspaceResponse: type: array items: $ref: '#/components/schemas/ShippingPackageAttributes' ShippingPackageListForWorkspace401Response: type: object properties: error: type: string ShippingPackageListForWorkspace404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingPackageAddToWorkspaceResponse: type: object properties: error: type: string ShippingPackageAddToWorkspace401Response: type: object properties: error: type: string ShippingPackageRemoveByIdResponse: type: object properties: error: type: string ShippingPackageRemoveById404Response: type: object properties: error: type: string ShippingPackageGetForWorkspaceResponse: type: object properties: error: type: string ShippingPackageGetForWorkspace404Response: type: object properties: error: type: string ShippingPackageUpdateForWorkspaceResponse: type: object properties: error: type: string ShippingPackageUpdateForWorkspace401Response: type: object properties: error: type: string ShippingPackageUpdateForWorkspace404Response: type: object properties: error: type: string ShippingProfileListResponse: type: array items: $ref: '#/components/schemas/ShippingProfileAttributes' ShippingProfileList401Response: type: object properties: error: type: string ShippingProfileList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingProfileCreateNewResponse: type: object properties: error: type: string ShippingProfileCreateNew401Response: type: object properties: error: type: string ShippingProfileRemoveResponse: type: object properties: error: type: string ShippingProfileRemove404Response: type: object properties: error: type: string ShippingProfileGetWorkspaceProfileResponse: type: object properties: error: type: string ShippingProfileGetWorkspaceProfile404Response: type: object properties: error: type: string ShippingProfileUpdateForWorkspaceResponse: type: object properties: error: type: string ShippingProfileUpdateForWorkspace401Response: type: object properties: error: type: string ShippingProfileUpdateForWorkspace404Response: type: object properties: error: type: string ShippingRateListForZoneResponse: type: array items: $ref: '#/components/schemas/ShippingRateAttributes' ShippingRateListForZone401Response: type: object properties: error: type: string ShippingRateListForZone404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingRateCreateRateForZoneResponse: type: object properties: error: type: string ShippingRateCreateRateForZone401Response: type: object properties: error: type: string ShippingRateRemoveByIdResponse: type: object properties: error: type: string ShippingRateRemoveById404Response: type: object properties: error: type: string ShippingRateGetRateByIdResponse: type: object properties: error: type: string ShippingRateGetRateById404Response: type: object properties: error: type: string ShippingRateUpdateRateForZoneResponse: type: object properties: error: type: string ShippingRateUpdateRateForZone401Response: type: object properties: error: type: string ShippingRateUpdateRateForZone404Response: type: object properties: error: type: string ShippingZoneListZonesResponse: type: array items: $ref: '#/components/schemas/ShippingZoneAttributes' ShippingZoneListZones401Response: type: object properties: error: type: string ShippingZoneListZones404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingZoneAddNewZoneResponse: type: object properties: error: type: string ShippingZoneAddNewZone401Response: type: object properties: error: type: string ShippingZoneRemoveByIdResponse: type: object properties: error: type: string ShippingZoneRemoveById404Response: type: object properties: error: type: string ShippingZoneGetZoneByIdResponse: type: object properties: error: type: string ShippingZoneGetZoneById404Response: type: object properties: error: type: string ShippingZoneUpdateZoneByIdResponse: type: object properties: error: type: string ShippingZoneUpdateZoneById401Response: type: object properties: error: type: string ShippingZoneUpdateZoneById404Response: type: object properties: error: type: string ShippingRatesNameListResponse: type: array items: $ref: '#/components/schemas/ShippingRatesNameAttributes' ShippingRatesNameList401Response: type: object properties: error: type: string ShippingRatesNameList404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string ShippingRatesNameCreateNewRateNameResponse: type: object properties: error: type: string ShippingRatesNameCreateNewRateName401Response: type: object properties: error: type: string ShippingRatesNameRemoveResponse: type: object properties: error: type: string ShippingRatesNameRemove404Response: type: object properties: error: type: string ShippingRatesNameGetRateNameResponse: type: object properties: error: type: string ShippingRatesNameGetRateName404Response: type: object properties: error: type: string ShippingRatesNameUpdateNameResponse: type: object properties: error: type: string ShippingRatesNameUpdateName401Response: type: object properties: error: type: string ShippingRatesNameUpdateName404Response: type: object properties: error: type: string WebhooksOutgoingEndpointListEndpointsResponse: type: array items: $ref: '#/components/schemas/WebhooksOutgoingEndpointAttributes' WebhooksOutgoingEndpointListEndpoints401Response: type: object properties: error: type: string WebhooksOutgoingEndpointListEndpoints404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string WebhooksOutgoingEndpointCreateNewResponse: type: object properties: error: type: string WebhooksOutgoingEndpointCreateNew401Response: type: object properties: error: type: string WebhooksOutgoingEndpointRemoveResponse: type: object properties: error: type: string WebhooksOutgoingEndpointRemove404Response: type: object properties: error: type: string WebhooksOutgoingEndpointGetResponse: type: object properties: error: type: string WebhooksOutgoingEndpointGet404Response: type: object properties: error: type: string WebhooksOutgoingEndpointUpdateEndpointResponse: type: object properties: error: type: string WebhooksOutgoingEndpointUpdateEndpoint401Response: type: object properties: error: type: string WebhooksOutgoingEndpointUpdateEndpoint404Response: type: object properties: error: type: string WebhooksOutgoingEventListForWorkspaceResponse: type: array items: $ref: '#/components/schemas/WebhooksOutgoingEventAttributes' WebhooksOutgoingEventListForWorkspace401Response: type: object properties: error: type: string WebhooksOutgoingEventListForWorkspace404Response: type: object properties: error: description: >- Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. type: string WebhooksOutgoingEventGetForWorkspaceResponse: type: object properties: error: type: string WebhooksOutgoingEventGetForWorkspace404Response: type: object properties: error: type: string headers: PaginationNext: description: >- ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page. schema: type: string Link: description: >- A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value. schema: type: string security: - BearerAuth: [] externalDocs: description: More in-depth guides and further resources url: https://developers.myclickfunnels.com x-readme: explorer-enabled: true proxy-enabled: true _id: 657da229004981004d16b219