About this integration
Open-source CRM and commerce platform for contacts, accounts, deals, and customer data.
There are 11 triggers, 40 search modules and 55 actions available. The integration connects via oauth or oauth authentication.
How to connect
The credential form asks for ORO - Subdomain, Oro - Client ID, Oro - Client Secret, and Oro - Subdomain.
Prefer the interactive builder form? Open it on the app page.
Sign in and approve access — your password is never shared with WEXTL®, and you can revoke access from the provider at any time.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
Connecting Oro CRM to WEXTL®
| Field | Type | Help |
|---|---|---|
ORO - SubdomainRequired | text | Open your Oro app in a web browser, and Copy your domain from the URL e.g |
Oro - Client IDRequired | text | Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), then copy the generated client_id |
Oro - Client SecretRequired | password | Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), and copy the generated client_secret |
| Field | Type | Help |
|---|---|---|
Oro - SubdomainRequired | text | Open your Oro app in a web browser, and Copy your domain from the URL e.g |
Oro - UsernameRequired | text | Your Oro account admin username |
Oro - PasswordRequired | password | Your Oro account admin password |
Oro - Client IDRequired | text | Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), then copy the generated client_id |
Oro - Client SecretRequired | password | Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), and copy the generated client_secret |
Use it in workflow automation
Start with Watch Accounts, then add Create a Checkout Record.
The canvas below runs Watch Accounts into Create a Checkout Record — watch the video, then drop a node onto the canvas.
Select the Watch Product Kit Items trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create an Order Line Item as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 66 ready-made modules for CRM work — each run logs its inputs and outputs for debugging.
Oro CRM workflow on the canvas: Watch Product Kit Items then Create an Order Line Item
Triggers, searches and actions
Open any Oro CRM trigger, search, or action to see its inputs and outputs — 11 triggers, 40 searchs, 55 actions.
Triggers
Use one of 11 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Accounts
- Watch Contacts
- Watch Conversations
- Watch Customer Address
- Watch Customers
6more triggers
Searches
This integration includes 40 search modules for looking data up mid-run.
- Get a Checkout Record
- Get a Contact
- Get a Conversation
- Get a Customer
- Get a Customer Conversation
35more searches
Actions
Take action during a run with 55 available modules that write data back into the app.
- Create a Checkout Record
- Create a Contact
- Create a Conversation
- Create a Customer
- Create a Customer Address
50more actions
Explore the fields available for each Oro CRM trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Extend description | text |
Last contacted date | date |
Last contacted date in | date |
Last contacted date out | date |
Name | text |
Times contacted | number |
Times contacted in | number |
Times contacted out | number |
Updated at | date |
Relationships | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Attachments | object |
B 2b customers | object |
Contacts | object |
Customers | object |
Default contact | object |
Organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Birthday | text |
Created at | date |
Description | text |
Emails | array |
Facebook | text |
Fax | text |
First name | text |
Gender | text |
Google plus | text |
Job title | text |
Relationships | object |
Accounts | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Addresses | object |
Assigned to | object |
Created by | object |
Default in accounts | object |
Groups | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Messages number | number |
Name | text |
Updated at | text |
Relationships | object |
Activity targets | object |
Customer | object |
Customer user | object |
Last message | object |
Messages | object |
Organization | object |
Owner | object |
Participants | object |
Source | object |
Status | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Name | text |
Updated at | date |
Relationships | object |
Account | object |
Activity notes | object |
Addresses | object |
Attachments | object |
Children | object |
Group | object |
Internal rating | object |
Organization | object |
Owner | object |
Parent | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Code | text |
Created at | date |
Description | text |
Updated at | date |
Relationships | object |
Organization | object |
Owner | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
From external source | boolean |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Relationships | object |
Country | object |
Customer address | object |
Customer user address | object |
Region | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Checksum | text |
Comment | text |
Created at | date |
Currency | text |
Free form product | text |
From external source | boolean |
Price type | number |
Product name | text |
Product sku | text |
Product unit code | text |
Relationships | object |
Kit item line items | object |
Orders | object |
Parent product | object |
Product | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Currency | text |
Customer notes | text |
Disable promotions | boolean |
Discount | number |
Estimated shipping cost amount | number |
External | boolean |
Identifier | text |
Last contacted date | date |
Last contacted date in | date |
Relationships | object |
Activity conversations | object |
Activity emails | object |
Activity notes | object |
Attachments | object |
Billing address | object |
Created by | object |
Customer | object |
Customer user | object |
Discounts | object |
Documents | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Maximum quantity | number |
Minimum quantity | number |
Optional | boolean |
Sort order | number |
Updated at | date |
Relationships | object |
Kit item products | object |
Labels | object |
Product kit | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Availability date | date |
Category sort order | number |
Created at | date |
Featured | boolean |
Kit shipping calculation method | text |
New arrival | boolean |
Product type | text |
Sku | text |
Status | text |
Updated at | text |
Relationships | object |
Activity notes | object |
Attachments | object |
Attribute family | object |
Back order | object |
Brand | object |
Category | object |
Decrement quantity | object |
Default variant | object |
Descriptions | object |
Highlight low inventory | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Searches
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
Relationships | object |
Billing address | object |
Shipping address | object |
Line items | object |
Input fields
| Field | Type |
|---|---|
ID | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Birthday | text |
Created at | date |
Description | text |
Emails | array |
Facebook | text |
Fax | text |
First name | text |
Gender | text |
Google plus | text |
Job title | text |
Relationships | object |
Accounts | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Addresses | object |
Assigned to | object |
Created by | object |
Default in accounts | object |
Groups | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Messages number | number |
Name | text |
Updated at | text |
Relationships | object |
Activity targets | object |
Customer | object |
Customer user | object |
Last message | object |
Messages | object |
Organization | object |
Owner | object |
Participants | object |
Source | object |
Status | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Name | text |
Updated at | date |
Relationships | object |
Account | object |
Activity notes | object |
Addresses | object |
Attachments | object |
Children | object |
Group | object |
Internal rating | object |
Organization | object |
Owner | object |
Parent | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Data | object |
Type | text |
ID | text |
Attributes | object |
Relationships | object |
Links | object |
Meta | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Included | array |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Relationships | object |
Activity notes | object |
Organization | object |
Owner | object |
Payment term | object |
Tax code | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Code | text |
Created at | date |
Description | text |
Updated at | date |
Relationships | object |
Organization | object |
Owner | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Extend description | text |
Last contacted date | date |
Last contacted date in | date |
Last contacted date out | date |
Name | text |
Times contacted | number |
Times contacted in | number |
Times contacted out | number |
Updated at | date |
Relationships | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Attachments | object |
B 2b customers | object |
Contacts | object |
Customers | object |
Default contact | object |
Organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Customer Address IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order ID | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Currency | text |
Customer notes | text |
Disable promotions | boolean |
Discount | number |
Estimated shipping cost amount | number |
External | boolean |
Identifier | text |
Last contacted date | date |
Last contacted date in | date |
Relationships | object |
Activity conversations | object |
Activity emails | object |
Activity notes | object |
Attachments | object |
Billing address | object |
Created by | object |
Customer | object |
Customer user | object |
Discounts | object |
Documents | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order Address IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
From external source | boolean |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Relationships | object |
Country | object |
Customer address | object |
Customer user address | object |
Region | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Amount | number |
Description | text |
Order discount type | text |
Percent | number |
Relationships | object |
Order | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
TypeRequired | choice |
Product SKURequired | text |
QuantityRequired | number |
ValueRequired | number |
CurrencyRequired | text |
Price TypeRequired | number |
Ship ByRequired | date |
OrdersRequired | array |
ProductRequired | object |
Type | text |
ID | text |
Product UnitRequired | object |
Type | text |
ID | text |
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Availability date | date |
Category sort order | number |
Created at | date |
Featured | boolean |
Kit shipping calculation method | text |
New arrival | boolean |
Product type | text |
Sku | text |
Status | text |
Updated at | text |
Relationships | object |
Activity notes | object |
Attachments | object |
Attribute family | object |
Back order | object |
Brand | object |
Category | object |
Decrement quantity | object |
Default variant | object |
Descriptions | object |
Highlight low inventory | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Fallback | text |
Wysiwyg | object |
Relationships | object |
Localization | object |
Product | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Product Kit Item IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Maximum quantity | number |
Minimum quantity | number |
Optional | boolean |
Sort order | number |
Updated at | date |
Relationships | object |
Kit item products | object |
Labels | object |
Product kit | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Currency | text |
Quantity | number |
Value | number |
Relationships | object |
Price list | object |
Product | object |
Unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Method | text |
Number | text |
Relationships | object |
Orders | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Updated at | date |
Relationships | object |
Image | object |
Product | object |
Types | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Extend description | text |
Last contacted date | date |
Last contacted date in | date |
Last contacted date out | date |
Name | text |
Times contacted | number |
Times contacted in | number |
Times contacted out | number |
Updated at | date |
Relationships | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Attachments | object |
B 2b customers | object |
Contacts | object |
Customers | object |
Default contact | object |
Organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Birthday | text |
Created at | date |
Description | text |
Emails | array |
Facebook | text |
Fax | text |
First name | text |
Gender | text |
Google plus | text |
Job title | text |
Relationships | object |
Accounts | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Addresses | object |
Assigned to | object |
Created by | object |
Default in accounts | object |
Groups | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Messages number | number |
Name | text |
Updated at | text |
Relationships | object |
Activity targets | object |
Customer | object |
Customer user | object |
Last message | object |
Messages | object |
Organization | object |
Owner | object |
Participants | object |
Source | object |
Status | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Filter by ID | choice |
Filter by ID (Equals) | choice |
Filter by ID (Not Equals) | choice |
Filter by Priority | text |
Filter by Priority (Equals) | text |
Filter by Priority (Not Equals) | text |
Filter by Priority (Less Than) | text |
Filter by Priority (Less Than or Equal) | text |
Filter by Priority (Greater Than) | text |
Filter by Priority (Greater Than or Equal) | text |
Filter by Priority (Exists) | boolean |
3other input fields
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Default | boolean |
Name | text |
Priority | number |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Comment | text |
Created at | date |
Updated at | date |
Relationships | object |
File | object |
Organization | object |
Owner | object |
Target | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Relationships | object |
Activity notes | object |
Organization | object |
Owner | object |
Payment term | object |
Tax code | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Currency | text |
Quantity | number |
Value | number |
Relationships | object |
Customer | object |
Product | object |
Unit | object |
Website | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Name | text |
Updated at | date |
Relationships | object |
Account | object |
Activity notes | object |
Addresses | object |
Attachments | object |
Children | object |
Group | object |
Internal rating | object |
Organization | object |
Owner | object |
Parent | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Code | text |
Created at | date |
Description | text |
Updated at | date |
Relationships | object |
Organization | object |
Owner | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
From external source | boolean |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Relationships | object |
Country | object |
Customer address | object |
Customer user address | object |
Region | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Checksum | text |
Comment | text |
Created at | date |
Currency | text |
Free form product | text |
From external source | boolean |
Price type | number |
Product name | text |
Product sku | text |
Product unit code | text |
Relationships | object |
Kit item line items | object |
Orders | object |
Parent product | object |
Product | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Currency | text |
Customer notes | text |
Disable promotions | boolean |
Discount | number |
Estimated shipping cost amount | number |
External | boolean |
Identifier | text |
Last contacted date | date |
Last contacted date in | date |
Relationships | object |
Activity conversations | object |
Activity emails | object |
Activity notes | object |
Attachments | object |
Billing address | object |
Created by | object |
Customer | object |
Customer user | object |
Discounts | object |
Documents | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Amount | number |
Description | text |
Order discount type | text |
Percent | number |
Relationships | object |
Order | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Fallback | text |
Wysiwyg | object |
Relationships | object |
Localization | object |
Product | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Updated at | date |
Relationships | object |
Image | object |
Product | object |
Types | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Maximum quantity | number |
Minimum quantity | number |
Optional | boolean |
Sort order | number |
Updated at | date |
Relationships | object |
Kit item products | object |
Labels | object |
Product kit | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Currency | text |
Quantity | number |
Value | number |
Relationships | object |
Price list | object |
Product | object |
Unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Availability date | date |
Category sort order | number |
Created at | date |
Featured | boolean |
Kit shipping calculation method | text |
New arrival | boolean |
Product type | text |
Sku | text |
Status | text |
Updated at | text |
Relationships | object |
Activity notes | object |
Attachments | object |
Attribute family | object |
Back order | object |
Brand | object |
Category | object |
Decrement quantity | object |
Default variant | object |
Descriptions | object |
Highlight low inventory | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Method | text |
Number | text |
Relationships | object |
Orders | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Actions
Input fields
| Field | Type |
|---|---|
Attributes | object |
Payment Method | text |
Shipping Method | text |
Shipping Method Type | text |
Output fields
| Field | Type |
|---|---|
Type | text |
Relationships | object |
Billing address | object |
Shipping address | object |
Line items | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
First Name | text |
Last Name | text |
Primary Phone | text |
Primary Email | |
Relationships | object |
Owner | object |
Organization | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Birthday | text |
Created at | date |
Description | text |
Emails | array |
Facebook | text |
Fax | text |
First name | text |
Gender | text |
Google plus | text |
Job title | text |
Relationships | object |
Accounts | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Addresses | object |
Assigned to | object |
Created by | object |
Default in accounts | object |
Groups | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
Conversation NameRequired | text |
Relationships | object |
Owner | object |
Organization | object |
Customer User | object |
Customer | object |
Status | object |
Source | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Messages number | number |
Name | text |
Updated at | text |
Relationships | object |
Activity targets | object |
Customer | object |
Customer user | object |
Last message | object |
Messages | object |
Organization | object |
Owner | object |
Participants | object |
Source | object |
Status | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
NameRequired | text |
Relationships | object |
Children | array |
Group | object |
Users | array |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Name | text |
Updated at | date |
Relationships | object |
Account | object |
Activity notes | object |
Addresses | object |
Attachments | object |
Children | object |
Group | object |
Internal rating | object |
Organization | object |
Owner | object |
Parent | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
CityRequired | text |
First NameRequired | text |
LabelRequired | text |
Last NameRequired | text |
Middle Name | text |
Name Prefix | text |
Name Suffix | text |
Organization | text |
Phone | text |
Postal CodeRequired | text |
Relationships | object |
Customer | object |
Country | object |
Region | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
AttributesRequired | object |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Relationships | object |
Activity notes | object |
Organization | object |
Owner | object |
Payment term | object |
Tax code | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
CodeRequired | text |
Description | text |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Code | text |
Created at | date |
Description | text |
Updated at | date |
Relationships | object |
Organization | object |
Owner | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
NameRequired | text |
Extended Description | text |
Relationships | object |
OwnerRequired | object |
Contacts | array |
Default Contact | object |
OrganizationRequired | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Extend description | text |
Last contacted date | date |
Last contacted date in | date |
Last contacted date out | date |
Name | text |
Times contacted | number |
Times contacted in | number |
Times contacted out | number |
Updated at | date |
Relationships | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Attachments | object |
B 2b customers | object |
Contacts | object |
Customers | object |
Default contact | object |
Organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
AttributesRequired | object |
IdentifierRequired | text |
PO Number | text |
Customer Notes | text |
Ship Until | date |
Currency | text |
RelationshipsRequired | object |
Billing AddressRequired | object |
Line Items | array |
CustomerRequired | object |
Included | array |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Currency | text |
Customer notes | text |
Disable promotions | boolean |
Discount | number |
Estimated shipping cost amount | number |
External | boolean |
Identifier | text |
Last contacted date | date |
Last contacted date in | date |
Relationships | object |
Activity conversations | object |
Activity emails | object |
Activity notes | object |
Attachments | object |
Billing address | object |
Created by | object |
Customer | object |
Customer user | object |
Discounts | object |
Documents | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
Phone | text |
Label | text |
Street | text |
City | text |
Postal Code | text |
First Name | text |
Last Name | text |
Relationships | object |
Country | object |
Region | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
From external source | boolean |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Relationships | object |
Country | object |
Customer address | object |
Customer user address | object |
Region | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Attributes | object |
Description | text |
AmountRequired | number |
Order Discount TypeRequired | text |
Relationships | object |
Order | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Amount | number |
Description | text |
Order discount type | text |
Percent | number |
Relationships | object |
Order | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
AttributesRequired | object |
IdentifierRequired | text |
PO Number | text |
Customer Notes | text |
Ship Until | date |
Currency | text |
RelationshipsRequired | object |
Billing AddressRequired | object |
Line Items | array |
CustomerRequired | object |
Included | array |
Output fields
| Field | Type |
|---|---|
TypeRequired | choice |
Product SKURequired | text |
QuantityRequired | number |
ValueRequired | number |
CurrencyRequired | text |
Price TypeRequired | number |
Ship ByRequired | date |
OrdersRequired | array |
ProductRequired | object |
Type | text |
ID | text |
Product UnitRequired | object |
Type | text |
ID | text |
Input fields
| Field | Type |
|---|---|
Decrement QuantityRequired | choice |
Manage InventoryRequired | choice |
Back OrderRequired | choice |
Product TypeRequired | choice |
StatusRequired | choice |
Featured | boolean |
New Arrival | boolean |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Availability date | date |
Category sort order | number |
Created at | date |
Featured | boolean |
Kit shipping calculation method | text |
New arrival | boolean |
Product type | text |
Sku | text |
Status | text |
Updated at | text |
Relationships | object |
Activity notes | object |
Attachments | object |
Attribute family | object |
Back order | object |
Brand | object |
Category | object |
Decrement quantity | object |
Default variant | object |
Descriptions | object |
Highlight low inventory | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
AttributesRequired | object |
Fallback | text |
WYSIWYG | object |
RelationshipsRequired | object |
LocalizationRequired | object |
ProductRequired | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Fallback | text |
Wysiwyg | object |
Relationships | object |
Localization | object |
Product | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Data | object |
TypeRequired | text |
IDRequired | choice |
Relationships | object |
Included | array |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Updated at | date |
Relationships | object |
Image | object |
Product | object |
Types | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
TypeRequired | choice |
Attributes | object |
QuantityRequired | number |
CurrencyRequired | text |
ValueRequired | number |
Relationships | object |
Price List | object |
Product | object |
Unit | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Currency | text |
Quantity | number |
Value | number |
Relationships | object |
Price list | object |
Product | object |
Unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
AttributesRequired | object |
Method | text |
Number | text |
RelationshipsRequired | object |
Orders | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Method | text |
Number | text |
Relationships | object |
Orders | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
OptionalRequired | boolean |
Product Kit | object |
Product IDRequired | choice |
Labels | array |
Kit Item Products | array |
Product Unit | object |
Product Unit IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Maximum quantity | number |
Minimum quantity | number |
Optional | boolean |
Sort order | number |
Updated at | date |
Relationships | object |
Kit item products | object |
Labels | object |
Product kit | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
ID | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Customer Address IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Order ID | choice |
Input fields
| Field | Type |
|---|---|
Order Address IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Product Kit Item IDRequired | choice |
Input fields
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
Payment Method | text |
Shipping Method | text |
Shipping Method Type | text |
Output fields
| Field | Type |
|---|---|
Type | text |
Relationships | object |
Billing address | object |
Shipping address | object |
Line items | object |
Input fields
| Field | Type |
|---|---|
ID | choice |
Attributes | object |
First Name | text |
Last Name | text |
Primary Phone | text |
Primary Email | |
Relationships | object |
Owner | object |
Organization | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Birthday | text |
Created at | date |
Description | text |
Emails | array |
Facebook | text |
Fax | text |
First name | text |
Gender | text |
Google plus | text |
Job title | text |
Relationships | object |
Accounts | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Addresses | object |
Assigned to | object |
Created by | object |
Default in accounts | object |
Groups | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
TypeRequired | choice |
Attributes | object |
Conversation Name | text |
Relationships | object |
Owner | object |
Organization | object |
Customer User | object |
Customer | object |
Status | choice |
Source | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Messages number | number |
Name | text |
Updated at | text |
Relationships | object |
Activity targets | object |
Customer | object |
Customer user | object |
Last message | object |
Messages | object |
Organization | object |
Owner | object |
Participants | object |
Source | object |
Status | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
Name | text |
Relationships | object |
Children | array |
Group | object |
Users | array |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Name | text |
Updated at | date |
Relationships | object |
Account | object |
Activity notes | object |
Addresses | object |
Attachments | object |
Children | object |
Group | object |
Internal rating | object |
Organization | object |
Owner | object |
Parent | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
Name | text |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Relationships | object |
Activity notes | object |
Organization | object |
Owner | object |
Payment term | object |
Tax code | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
CodeRequired | text |
Description | text |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Code | text |
Created at | date |
Description | text |
Updated at | date |
Relationships | object |
Organization | object |
Owner | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Account IDRequired | choice |
Attributes | object |
NameRequired | text |
Extended Description | text |
Relationships | object |
OwnerRequired | object |
Contacts | array |
Default Contact | object |
OrganizationRequired | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Extend description | text |
Last contacted date | date |
Last contacted date in | date |
Last contacted date out | date |
Name | text |
Times contacted | number |
Times contacted in | number |
Times contacted out | number |
Updated at | date |
Relationships | object |
Activity calls | object |
Activity emails | object |
Activity notes | object |
Activity tasks | object |
Attachments | object |
B 2b customers | object |
Contacts | object |
Customers | object |
Default contact | object |
Organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Customer Address IDRequired | choice |
Attributes | object |
CityRequired | text |
First Name | text |
Address Label | text |
Last Name | text |
Middle Name | text |
Name Prefix | text |
Name Suffix | text |
Organization | text |
Phone | text |
Postal CodeRequired | text |
Relationships | object |
Country | object |
Region | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Organization | text |
Relationships | object |
Country | object |
Customer | object |
Owner | object |
Region | object |
System organization | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order IDRequired | choice |
Attributes | object |
Identifier | text |
PO Number | text |
Customer Notes | text |
Ship Until | date |
Currency | text |
Relationships | object |
Billing Address | object |
Line Items | array |
Customer | object |
Included | array |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Currency | text |
Customer notes | text |
Disable promotions | boolean |
Discount | number |
Estimated shipping cost amount | number |
External | boolean |
Identifier | text |
Last contacted date | date |
Last contacted date in | date |
Relationships | object |
Activity conversations | object |
Activity emails | object |
Activity notes | object |
Attachments | object |
Billing address | object |
Created by | object |
Customer | object |
Customer user | object |
Discounts | object |
Documents | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order Address IDRequired | choice |
Attributes | object |
Phone | text |
Label | text |
Street | text |
City | text |
Postal Code | text |
First Name | text |
Last Name | text |
Relationships | object |
Country | object |
Region | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
City | text |
Created at | date |
Custom region | text |
First name | text |
From external source | boolean |
Label | text |
Last name | text |
Middle name | text |
Name prefix | text |
Name suffix | text |
Relationships | object |
Country | object |
Customer address | object |
Customer user address | object |
Region | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
Attributes | object |
Description | text |
AmountRequired | number |
Order Discount TypeRequired | text |
Relationships | object |
Order | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Amount | number |
Description | text |
Order discount type | text |
Percent | number |
Relationships | object |
Order | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
PO Number | text |
Customer Notes | text |
Ship Until | date |
Currency | text |
Relationships | object |
Billing Address | object |
Line Items | array |
Customer | object |
Included | array |
Output fields
| Field | Type |
|---|---|
TypeRequired | choice |
Product SKURequired | text |
QuantityRequired | number |
ValueRequired | number |
CurrencyRequired | text |
Price TypeRequired | number |
Ship ByRequired | date |
OrdersRequired | array |
ProductRequired | object |
Type | text |
ID | text |
Product UnitRequired | object |
Type | text |
ID | text |
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Decrement Quantity | choice |
Manage Inventory | choice |
Back Order | choice |
Product Type | choice |
Status | choice |
Featured | boolean |
New Arrival | boolean |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Availability date | date |
Category sort order | number |
Created at | date |
Featured | boolean |
Kit shipping calculation method | text |
New arrival | boolean |
Product type | text |
Sku | text |
Status | text |
Updated at | text |
Relationships | object |
Activity notes | object |
Attachments | object |
Attribute family | object |
Back order | object |
Brand | object |
Category | object |
Decrement quantity | object |
Default variant | object |
Descriptions | object |
Highlight low inventory | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
Fallback | text |
WYSIWYG | object |
Relationships | object |
Localization | object |
Product | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Fallback | text |
Wysiwyg | object |
Relationships | object |
Localization | object |
Product | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Product Kit Item IDRequired | choice |
OptionalRequired | boolean |
Product Kit | object |
Product Kit IDRequired | choice |
Labels | array |
Kit Item Products | array |
Product Unit | object |
Product Unit IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Maximum quantity | number |
Minimum quantity | number |
Optional | boolean |
Sort order | number |
Updated at | date |
Relationships | object |
Kit item products | object |
Labels | object |
Product kit | object |
Product unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Type | choice |
Attributes | object |
Quantity | number |
Currency | text |
Value | number |
Relationships | object |
Price List | object |
Product | object |
Unit | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Currency | text |
Quantity | number |
Value | number |
Relationships | object |
Price list | object |
Product | object |
Unit | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
AttributesRequired | object |
Method | text |
Number | text |
RelationshipsRequired | object |
Orders | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Method | text |
Number | text |
Relationships | object |
Orders | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | choice |
Relationships | object |
Image | object |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Updated at | date |
Relationships | object |
Image | object |
Product | object |
Types | object |
Links | object |
Self | object |
Additional prop 1 | object |
Additional prop 2 | object |
Additional prop 3 | object |
Meta | object |
Additional prop 1 | object |