Requirements
Oro CRM requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]
Get your Oro CRM credentials
Oro - Primary
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- ORO - SubdomaintextRequired
Open your Oro app in a web browser, and Copy your domain from the URL e.g
[1]https://example.orocrm.com - Oro - Client IDtextRequired
Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), then copy the generated client_id
[1] - Oro - Client SecretpasswordRequired
Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), and copy the generated client_secret
[1]
Oro - Secondary
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Oro - SubdomaintextRequired
Open your Oro app in a web browser, and Copy your domain from the URL e.g
[1]https://example.orocrm.com - Oro - UsernametextRequired
Your Oro account admin username
[1] - Oro - PasswordpasswordRequired
Your Oro account admin password
[1] - Oro - Client IDtextRequired
Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), then copy the generated client_id
[1] - Oro - Client SecretpasswordRequired
Create an OAuth application from your Oro My User → OAuth Applications menu (after configuring encryption keys), and copy the generated client_secret
[1]
Connect Oro CRM in WEXTL
- Log in to your WEXTL account, add the Oro CRM node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Oro CRM account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Oro CRM node modules
The list below is a reference of every Oro CRM node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Oro CRM node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch AccountsTrigger
| 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 |
Watch ContactsTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Birthday | text |
| Created at | date |
| Description | text |
| Emails | array |
| 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 |
Watch ConversationsTrigger
| 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 |
Watch Customer AddressTrigger
| 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 |
Watch Customer Tax CodesTrigger
| 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 |
Watch CustomersTrigger
| 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 |
Watch Order AddressTrigger
| 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 |
Watch Order LineTrigger
| 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 |
Watch OrdersTrigger
| 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 |
Watch Product Kit ItemsTrigger
| 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 |
Watch ProductsTrigger
| 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 |
Get a Checkout RecordAction
Get a ContactAction
| Field | Type |
|---|---|
| ID | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Birthday | text |
| Created at | date |
| Description | text |
| Emails | array |
| 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 |
Get a ConversationAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get a CustomerAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get a Customer ConversationAction
Get a Customer GroupAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get a Customer Tax CodeAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get a ProductAction
| Field | Type |
|---|---|
Product IDRequired | choice |
| 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 |
Get a Product DescriptionAction
Get a Product Kit's ItemsAction
| Field | Type |
|---|---|
Product Kit Item IDRequired | choice |
| 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 |
Get a Product PriceAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get a Shipping TrackingAction
Get an AccountAction
| Field | Type |
|---|---|
Account IDRequired | choice |
| 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 |
Get an AddressAction
| Field | Type |
|---|---|
Customer Address IDRequired | choice |
| 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 |
Get an OrderAction
| Field | Type |
|---|---|
| Order ID | choice |
| 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 |
Get an Order AddressAction
| Field | Type |
|---|---|
Order Address IDRequired | choice |
| 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 |
Get an Order DiscountAction
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
| 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 |
Get an Order Line ItemAction
| Field | Type |
|---|---|
IDRequired | choice |
| 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 |
Get Product ImagesAction
| Field | Type |
|---|---|
Product Image IDRequired | choice |
| 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 |
List AccountsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List AddressesSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List ContactsSearch
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Birthday | text |
| Created at | date |
| Description | text |
| Emails | array |
| 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 |
List Conversation StatusesSearch
| 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 |
| 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 |
List ConversationsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Customer AddressesSearch
| Field | Type |
|---|---|
IDRequired | choice |
| Limit | number |
| 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 |
List Customer AttachmentsSearch
| Field | Type |
|---|---|
IDRequired | choice |
| Limit | number |
| 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 |
List Customer GroupsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Customer PricesSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Customer TaxcodesSearch
| Field | Type |
|---|---|
IDRequired | choice |
| Limit | number |
| 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 |
List CustomersSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Order AddressesSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Order Line ItemsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List OrdersSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Orders DiscountsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Product DescriptionsSearch
List Product ImagesSearch
List Product Kit ItemsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Product PricesSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List ProductsSearch
| Field | Type |
|---|---|
| Limit | number |
| 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 |
List Shipping TrackingSearch
Create a Checkout RecordAction
Create a ContactAction
| Field | Type |
|---|---|
| Attributes | object |
| First Name | text |
| Last Name | text |
| Primary Phone | text |
| Primary Email | |
| Relationships | object |
| Owner | object |
| Organization | object |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Birthday | text |
| Created at | date |
| Description | text |
| Emails | array |
| 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 |
Create a ConversationAction
| Field | Type |
|---|---|
| Attributes | object |
Conversation NameRequired | text |
| Relationships | object |
| Owner | object |
| Organization | object |
| Customer User | object |
| Customer | object |
| Status | object |
| Source | object |
| 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 |
Create a CustomerAction
| Field | Type |
|---|---|
| Attributes | object |
NameRequired | text |
| Relationships | object |
| Children | array |
| Group | object |
| Users | array |
| 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 |
Create a Customer AddressAction
| 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 |
| 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 |
Create a Customer GroupAction
| Field | Type |
|---|---|
AttributesRequired | object |
NameRequired | text |
| 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 |
Create a Customer Tax CodeAction
| Field | Type |
|---|---|
CodeRequired | text |
| Description | text |
| 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 |
Create a ProductAction
| Field | Type |
|---|---|
Decrement QuantityRequired | choice |
Manage InventoryRequired | choice |
Back OrderRequired | choice |
Product TypeRequired | choice |
StatusRequired | choice |
| Featured | boolean |
| New Arrival | boolean |
| 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 |
Create a Product DescriptionAction
| Field | Type |
|---|---|
AttributesRequired | object |
| Fallback | text |
| WYSIWYG | object |
RelationshipsRequired | object |
LocalizationRequired | object |
ProductRequired | object |
| 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 |
Create a Product ImageAction
| Field | Type |
|---|---|
| Data | object |
TypeRequired | text |
IDRequired | choice |
| Relationships | object |
| Included | array |
| 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 |
Create a Product PriceAction
| Field | Type |
|---|---|
TypeRequired | choice |
| Attributes | object |
QuantityRequired | number |
CurrencyRequired | text |
ValueRequired | number |
| Relationships | object |
| Price List | object |
| Product | object |
| Unit | object |
| 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 |
Create a Shipping TrackingAction
| Field | Type |
|---|---|
AttributesRequired | object |
| Method | text |
| Number | text |
RelationshipsRequired | object |
| Orders | object |
| 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 |
Create an AccountAction
| Field | Type |
|---|---|
| Attributes | object |
NameRequired | text |
| Extended Description | text |
| Relationships | object |
OwnerRequired | object |
| Contacts | array |
| Default Contact | object |
OrganizationRequired | object |
| 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 |
Create an OrderAction
| 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 |
| 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 |
Create an Order AddressAction
| 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 |
| 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 |
Create an Order DiscountAction
| Field | Type |
|---|---|
| Attributes | object |
| Description | text |
AmountRequired | number |
Order Discount TypeRequired | text |
| Relationships | object |
| Order | object |
| 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 |
Create an Order Line ItemAction
| 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 |
| 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 |
Create Product Kit ItemsAction
| Field | Type |
|---|---|
OptionalRequired | boolean |
| Product Kit | object |
Product IDRequired | choice |
| Labels | array |
| Kit Item Products | array |
| Product Unit | object |
Product Unit IDRequired | choice |
| 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 |
Delete a Checkout RecordAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a ContactAction
| Field | Type |
|---|---|
| ID | choice |
Delete a ConversationAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a CustomerAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a Customer GroupAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a Customer TaxcodeAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a ProductAction
| Field | Type |
|---|---|
Product IDRequired | choice |
Delete a Product DescriptionAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a Product ImageAction
| Field | Type |
|---|---|
Product Image IDRequired | choice |
Delete a Product PriceAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a Shipping TrackingAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete an AccountAction
| Field | Type |
|---|---|
Account IDRequired | choice |
Delete an AddressAction
| Field | Type |
|---|---|
Customer Address IDRequired | choice |
Delete an OrderAction
| Field | Type |
|---|---|
| Order ID | choice |
Delete an Order AddressAction
| Field | Type |
|---|---|
Order Address IDRequired | choice |
Delete an Order DiscountAction
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
Delete an Order Line ItemAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete Product Kit ItemsAction
| Field | Type |
|---|---|
Product Kit Item IDRequired | choice |
Make an API Calluniversal
Update a Checkout RecordAction
Update a ContactAction
| Field | Type |
|---|---|
| ID | choice |
| Attributes | object |
| First Name | text |
| Last Name | text |
| Primary Phone | text |
| Primary Email | |
| Relationships | object |
| Owner | object |
| Organization | object |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Birthday | text |
| Created at | date |
| Description | text |
| Emails | array |
| 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 |
Update a ConversationAction
| 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 |
| 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 |
Update a CustomerAction
| Field | Type |
|---|---|
IDRequired | choice |
| Attributes | object |
| Name | text |
| Relationships | object |
| Children | array |
| Group | object |
| Users | array |
| 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 |
Update a Customer GroupAction
| Field | Type |
|---|---|
IDRequired | choice |
| Attributes | object |
| Name | text |
| 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 |
Update a Customer TaxcodeAction
| Field | Type |
|---|---|
IDRequired | choice |
CodeRequired | text |
| Description | text |
| 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 |
Update a ProductAction
| Field | Type |
|---|---|
Product IDRequired | choice |
| Decrement Quantity | choice |
| Manage Inventory | choice |
| Back Order | choice |
| Product Type | choice |
| Status | choice |
| Featured | boolean |
| New Arrival | boolean |
| 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 |
Update a Product DescriptionAction
| Field | Type |
|---|---|
IDRequired | choice |
| Attributes | object |
| Fallback | text |
| WYSIWYG | object |
| Relationships | object |
| Localization | object |
| Product | object |
| 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 |
Update a Product KitAction
| 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 |
| 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 |
Update a Product PriceAction
| Field | Type |
|---|---|
IDRequired | choice |
| Type | choice |
| Attributes | object |
| Quantity | number |
| Currency | text |
| Value | number |
| Relationships | object |
| Price List | object |
| Product | object |
| Unit | object |
| 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 |
Update a Shipping TrackingAction
| Field | Type |
|---|---|
IDRequired | choice |
AttributesRequired | object |
| Method | text |
| Number | text |
RelationshipsRequired | object |
| Orders | object |
| 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 |
Update an AccountAction
| Field | Type |
|---|---|
Account IDRequired | choice |
| Attributes | object |
NameRequired | text |
| Extended Description | text |
| Relationships | object |
OwnerRequired | object |
| Contacts | array |
| Default Contact | object |
OrganizationRequired | object |
| 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 |
Update an AddressAction
| 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 |
| 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 |
Update an OrderAction
| 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 |
| 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 |
Update an Order AddressAction
| 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 |
| 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 |
Update an Order DiscountAction
| Field | Type |
|---|---|
Order Discount IDRequired | choice |
| Attributes | object |
| Description | text |
AmountRequired | number |
Order Discount TypeRequired | text |
| Relationships | object |
| Order | object |
| 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 |
Update an Order Line ItemAction
| 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 |
| 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 |
Update Product ImagesAction
| Field | Type |
|---|---|
Product Image IDRequired | choice |
| Relationships | object |
| Image | object |
| 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 |
Templates
Look for Oro CRM templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bigin[2]Simple pipeline-based CRM for small businesses, by Zoho.
- CirqllSimple CRM for SMBs to manage contacts, deals, tasks, and customer follow-up.
- Capsule CRMCRM for contacts, sales pipelines, projects, and tasks.
- Close CRMSales CRM built for closing deals with calling and email built in.
- BloomerangNonprofit CRM — constituents, donations, campaigns, and households.
References
- WEXTL® Oro CRM Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Oro CRM.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12
