About this integration
Subscription commerce platform that enables e-commerce brands to build and manage recurring order programs.
There are 10 triggers, 27 search modules and 57 actions available. The integration connects via basic authentication.
How to connect
The credential form asks for Environment and API Key.
Prefer the interactive builder form? Open it on the app page.
Paste your credentials once — WEXTL® stores them encrypted and reuses the connection across every workflow that needs it.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
Connecting Ordergroove to WEXTL®
| Field | Type | Help |
|---|---|---|
EnvironmentRequired | select | Select the environment you want to connect to. |
API KeyRequired | password | Enter your Application API Key. In your Merchant Dashboard, go to Developers > API Keys and create a new API key. Copy the generated token and paste it here. The key should have the permissions required for the resources and actions you plan to use. |
Use it in workflow automation
Start with Watch Addresses, then add Bulk Create Products.
The canvas below runs Watch Addresses into Bulk Create Products — watch the video, then drop a node onto the canvas.
Select the Watch Subscriptions trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create Subscription From Item as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 67 ready-made modules for finance work — each run logs its inputs and outputs for debugging.
Ordergroove workflow on the canvas: Watch Subscriptions then Create Subscription From Item
Triggers, searches and actions
Open any Ordergroove trigger, search, or action to see its inputs and outputs — 10 triggers, 27 searchs, 57 actions.
Triggers
Use one of 10 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Addresses
- Watch Customers
- Watch Entitlements
- Watch Items
- Watch One-Time Incentive
5more triggers
Searches
This integration includes 27 search modules for looking data up mid-run.
- Get a Customer
- Get an Address
- Get an Item
- Get an Order
- Get a Product
22more searches
Actions
Take action during a run with 57 available modules that write data back into the app.
- Bulk Create Products
- Bulk Update Products
- Cancel a Subscription
- Cancel Order
- Change Prepaid Renewal Behavior
52more actions
Explore the fields available for each Ordergroove trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Customer | text |
Public ID | text |
Label | text |
First name | text |
Last name | text |
Company name | text |
Address | text |
Address 2 | text |
City | text |
State province code | text |
Zip postal code | text |
Phone | text |
Fax | text |
6other output fields
Output fields
| Field | Type |
|---|---|
Merchant | text |
Merchant user ID | text |
Session ID | text |
User token ID | text |
First name | text |
Last name | text |
Email | text |
Phone number | text |
Phone type | number |
Live | boolean |
Created | date |
Last updated | date |
Last login | date |
2other output fields
Output fields
| Field | Type |
|---|---|
Merchant | text |
Public ID | text |
Merchant user ID | text |
Initial activation date | date |
Latest activation date | date |
Grace period | text |
Live | boolean |
Access type | text |
Expiration | text |
Created | date |
Last updated | date |
Resource | object |
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Grantees | array |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
Order updated | date |
2other output fields
Output fields
| Field | Type |
|---|---|
Public ID | text |
External code | text |
Description | text |
Merchant | text |
Customer | text |
Order | text |
Created | date |
Last updated | date |
Applied at | date |
Incentive | object |
Type | text |
Public ID | text |
Discount type | text |
Target | text |
Field | text |
Name | text |
Value | text |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | text |
Updated | text |
Place | text |
10other output fields
Output fields
| Field | Type |
|---|---|
Customer | text |
Billing address | text |
Cc number ending | text |
Public ID | text |
Label | text |
Token ID | text |
Cc holder | text |
Cc type | number |
Cc exp date | text |
Payment method | text |
Live | boolean |
Created | date |
Last updated | date |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Groups | array |
Name | text |
Price | text |
Image URL | text |
Detail URL | text |
External product ID | text |
Sku | text |
Autoship enabled | boolean |
Premier enabled | number |
Created | date |
Last update | date |
Live | boolean |
8other output fields
Output fields
| Field | Type |
|---|---|
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Product attribute | text |
Price | text |
Frequency days | number |
Reminder days | number |
Start date | date |
Cancelled | date |
Cancel reason code | text |
Cancel reason | text |
Merchant order ID | text |
Subscription type | text |
Components | array |
Created | date |
3other output fields
Searches
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Merchant user ID | text |
Session ID | text |
User token ID | text |
First name | text |
Last name | text |
Email | text |
Phone number | text |
Phone type | number |
Live | boolean |
Created | date |
Last updated | date |
Last login | date |
2other output fields
Input fields
| Field | Type |
|---|---|
Address IDRequired | choice |
Output fields
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Input fields
| Field | Type |
|---|---|
Item ID | choice |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
Order updated | date |
2other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Include Has Plan | boolean |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Include Product Selection Rules | boolean |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Groups | array |
Name | text |
Price | text |
Image URL | url |
Detail URL | url |
External product ID | text |
Sku | text |
Autoship enabled | boolean |
Premier enabled | number |
Created | date |
Last update | date |
Live | boolean |
8other output fields
Input fields
| Field | Type |
|---|---|
ResourceRequired | choice |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Product attribute | text |
Price | text |
Frequency days | number |
Reminder days | number |
Start date | date |
Cancelled | date |
Cancel reason code | text |
Cancel reason | text |
Merchant order ID | text |
Subscription type | text |
Components | array |
Created | date |
3other output fields
Input fields
| Field | Type |
|---|---|
Session IDRequired | text |
Output fields
| Field | Type |
|---|---|
Cart ID | text |
Offer ID | text |
Incentives | object |
Initial | array |
Ongoing | array |
Attributes | text |
Coupon code | text |
Quantity | number |
Every | number |
Every period | number |
Input fields
| Field | Type |
|---|---|
One-Time IncentiveRequired | choice |
Output fields
| Field | Type |
|---|---|
Public ID | text |
External code | text |
Description | text |
Merchant | text |
Customer | text |
Order | text |
Created | date |
Last updated | date |
Incentive | object |
Type | text |
Public ID | text |
Discount type | text |
Target | text |
Field | text |
Name | text |
Value | text |
Applied at | text |
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Billing address | text |
Cc number ending | text |
Public ID | text |
Label | text |
Token ID | text |
Cc holder | text |
Cc type | number |
Cc exp date | date |
Payment method | text |
Live | boolean |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
Subscription Request IDRequired | text |
Output fields
| Field | Type |
|---|---|
Customer | text |
Payment | text |
Errors | object |
Shipping address | text |
Subscriptions | array |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Output fields
| Field | Type |
|---|---|
Ordinal | number |
Rotating product | text |
Subscription | text |
Active | boolean |
Input fields
| Field | Type |
|---|---|
ComponentRequired | text |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Quantity | number |
Product | text |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Active | boolean |
Updated After | date |
Updated Before | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
Customer | text |
Public ID | text |
Label | text |
First name | text |
Last name | text |
Company name | text |
Address | text |
Address 2 | text |
City | text |
State province code | text |
Zip postal code | text |
Phone | text |
Fax | text |
6other output fields
Input fields
| Field | Type |
|---|---|
Application | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Cancel reason | number |
Application | text |
Input fields
| Field | Type |
|---|---|
Active Status | boolean |
Email | |
Updated Date | date |
Updated After | date |
Updated Before | date |
Created Date | date |
Created After | date |
Created Before | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Merchant user ID | text |
Session ID | text |
User token ID | text |
First name | text |
Last name | text |
Email | text |
Phone number | text |
Phone type | number |
Live | boolean |
Created | date |
Last updated | date |
Last login | date |
2other output fields
Input fields
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Customer | choice |
External Resource ID | choice |
Resource Public ID | choice |
Resource Public IDs | choice |
Grantee External IDs | choice |
Live | boolean |
Resource Name | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Public ID | text |
Merchant user ID | text |
Initial activation date | date |
Latest activation date | date |
Grace period | text |
Live | boolean |
Access type | text |
Expiration | text |
Created | date |
Last updated | date |
Resource | object |
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Grantees | array |
Input fields
| Field | Type |
|---|---|
Order ID | choice |
Offer ID | choice |
Subscription ID | choice |
One Time | boolean |
Order Status | number |
Place Date | date |
Place Date From | date |
Place Date To | date |
Product ID | text |
Omit Price Calculation | boolean |
Order Updated From | date |
Order Updated To | date |
Include Incentives | boolean |
1other input field
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
Order updated | date |
2other output fields
Input fields
| Field | Type |
|---|---|
Offer Profile Category | choice |
Status | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Name | text |
Weight | number |
Live | boolean |
Status | text |
Offers | array |
Recurring coupon | object |
Public ID | text |
Name | text |
Code | text |
Discounts | array |
Initial coupon | object |
Public ID | text |
Name | text |
Code | text |
Discounts | array |
Input fields
| Field | Type |
|---|---|
Order | choice |
Customer | choice |
External Code | text |
Item | choice |
Created Date | date |
Created From | date |
Created To | date |
Last Updated Date | date |
Last Updated From | date |
Last Updated To | date |
Applied Date | date |
Applied From | date |
Applied To | date |
2other input fields
Output fields
| Field | Type |
|---|---|
Public ID | text |
External code | text |
Description | text |
Merchant | text |
Customer | text |
Order | text |
Created | date |
Last updated | date |
Applied at | date |
Incentive | object |
Type | text |
Public ID | text |
Discount type | text |
Target | text |
Field | text |
Name | text |
Value | text |
Input fields
| Field | Type |
|---|---|
Status | number |
Subscription | choice |
Customer | choice |
Place Date | date |
Place Date From | date |
Place Date To | date |
Created Date | date |
Created From | date |
Created To | date |
Updated Date | date |
Updated From | date |
Updated To | date |
Include Has Plan | boolean |
1other input field
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | text |
Updated | text |
Place | text |
10other output fields
Input fields
| Field | Type |
|---|---|
Customer | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Customer | text |
Billing address | text |
Cc number ending | text |
Public ID | text |
Label | text |
Token ID | text |
Cc holder | text |
Cc type | number |
Cc exp date | text |
Payment method | text |
Live | boolean |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
Name | text |
Group Type | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Name | text |
Group type | text |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Relationship Type | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Relationship type | text |
From product | text |
To product | text |
Input fields
| Field | Type |
|---|---|
Search | text |
Search Field | choice |
Product ID or Name | text |
Autoship Enabled | choice |
Discontinued Products | choice |
Group Name | text |
Group Type | choice |
Autoship By Default | boolean |
Active | boolean |
External Product IDs | array |
Product Type | choice |
Include Product Selection Rules | boolean |
Limit | number |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Groups | array |
Name | text |
Price | text |
Image URL | text |
Detail URL | text |
External product ID | text |
Sku | text |
Autoship enabled | boolean |
Premier enabled | number |
Created | date |
Last update | date |
Live | boolean |
8other output fields
Input fields
| Field | Type |
|---|---|
External Resource ID | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
Status | boolean |
Product | choice |
Customer | choice |
Shipping Address | text |
Created Date | date |
Created After | date |
Created Before | date |
Updated Date | date |
Updated After | date |
Updated Before | date |
Limit | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Product attribute | text |
Price | text |
Frequency days | number |
Reminder days | number |
Start date | date |
Cancelled | date |
Cancel reason code | text |
Cancel reason | text |
Merchant order ID | text |
Subscription type | text |
Components | array |
Created | date |
3other output fields
Actions
Input fields
| Field | Type |
|---|---|
Force All Fields | boolean |
ProductsRequired | array |
Product IDRequired | choice |
Name | text |
SKU | text |
Price | number |
Active | boolean |
Image URL | url |
Detail URL | url |
Autoship Enabled | boolean |
Prepaid Eligible | boolean |
Discontinued | boolean |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Status | number |
Input fields
| Field | Type |
|---|---|
ProductsRequired | array |
Product IDRequired | choice |
Name | text |
SKU | text |
Price | number |
Active | boolean |
Image URL | url |
Detail URL | url |
Autoship Enabled | boolean |
Prepaid Eligible | boolean |
Discontinued | boolean |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Status | number |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Renewal BehaviorRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Raw subscription type | text |
Components | array |
Extra data | object |
Shopify contract ID | text |
Public ID | text |
Quantity | number |
Price | text |
21other output fields
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Output fields
| Field | Type |
|---|---|
Product has group | boolean |
Input fields
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Merchant User IDRequired | choice |
Session IDRequired | text |
User Token IDRequired | text |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
Phone NumberRequired | text |
Phone TypeRequired | choice |
ActiveRequired | boolean |
Created DateRequired | date |
Last UpdatedRequired | date |
Last LoginRequired | date |
4other input fields
Output fields
| Field | Type |
|---|---|
Merchant | text |
Merchant user ID | text |
Session ID | text |
User token ID | text |
First name | text |
Last name | text |
Email | |
Phone number | text |
Phone type | text |
Live | text |
Created | date |
Last updated | date |
Last login | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Address TypeRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Label | text |
Company Name | text |
Address Line 1Required | text |
Address Line 2 | text |
CityRequired | text |
State / Province CodeRequired | text |
ZIP / Postal CodeRequired | text |
Country CodeRequired | text |
PhoneRequired | text |
2other input fields
Output fields
| Field | Type |
|---|---|
Customer | text |
Public ID | text |
Label | text |
First name | text |
Last name | text |
Company name | text |
Address | text |
Address 2 | text |
City | text |
State province code | text |
Zip postal code | text |
Phone | text |
Fax | text |
5other output fields
Input fields
| Field | Type |
|---|---|
Merchant IDRequired | choice |
CustomerRequired | choice |
Shipping AddressRequired | choice |
PaymentRequired | choice |
OfferRequired | choice |
ProductRequired | choice |
Place DateRequired | date |
QuantityRequired | number |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Subscription component | text |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
3other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Card Number EndingRequired | text |
Card Holder | text |
Expiration Date | text |
Billing Address | choice |
Label | text |
Token IDRequired | text |
Credit Card Type | text |
Payment Method | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Billing address | text |
Cc number ending | text |
Public ID | text |
Label | text |
Token ID | text |
Cc holder | text |
Cc type | number |
Cc exp date | date |
Payment method | text |
Live | boolean |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
External Resource IDRequired | choice |
Description | text |
Image URL | url |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Duration (Days)Required | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Duration in days | number |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
Merchant IDRequired | choice |
CustomerRequired | choice |
Description | text |
Expiration Date | date |
Item | choice |
Order | choice |
Stacking Type | choice |
External Code | text |
Incentive | object |
NameRequired | text |
Discount TypeRequired | choice |
ValueRequired | text |
FieldRequired | choice |
TypeRequired | text |
TargetRequired | choice |
Limit Policy | choice |
Limit Value | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
External code | text |
Description | text |
Merchant | text |
Customer | text |
Item | text |
Created | text |
Last updated | text |
Order | text |
Incentive | object |
Type | text |
Public ID | text |
Discount type | text |
Target | text |
Field | text |
Name | text |
Value | text |
Threshold field | text |
Threshold value | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Group TypeRequired | choice |
Merchant IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Name | text |
Group type | text |
Input fields
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Ordergroove Cart Tracking | boolean |
Session ID | text |
Merchant Order IDRequired | text |
Customer | object |
User ID | text |
First Name | text |
Last Name | text |
Email | text |
Phone Number | text |
Price Code | text |
Extra Data | array |
Shipping Address | object |
First Name | text |
Last Name | text |
Label | text |
Company Name | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
State / Province Code | text |
ZIP / Postal Code | text |
Country Code | text |
Billing Address | object |
First Name | text |
Last Name | text |
Label | text |
Company Name | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
State / Province Code | text |
ZIP / Postal Code | text |
Country Code | text |
Payment | object |
Card Number | text |
Card Holder | text |
Expiration Date | text |
Label | text |
Token ID | text |
Card Type | text |
Payment Method | choice |
Products | array |
Output fields
| Field | Type |
|---|---|
Result | text |
Subs req ID | text |
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
EveryRequired | number |
Period TypeRequired | number |
Offer | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
EveryRequired | number |
Period TypeRequired | number |
Start DateRequired | date |
Next Order Date | date |
Extra Data | object |
Key | text |
Value | text |
Components | array |
ProductRequired | choice |
Quantity | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Product attribute | text |
Price | text |
Frequency days | number |
Reminder days | number |
Start date | date |
Cancelled | date |
Cancel reason code | text |
Cancel reason | text |
Merchant order ID | text |
Subscription type | text |
Components | array |
Created | date |
3other output fields
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Output fields
| Field | Type |
|---|---|
Detail | text |
Input fields
| Field | Type |
|---|---|
One-Time IncentiveRequired | choice |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
EnvironmentRequired | choice |
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 |
|---|---|
Rotating ProductRequired | choice |
Configuration | object |
Reveal Moment | choice |
Pricing Policy | choice |
Selection Rules To Create | array |
Delivery ProductRequired | choice |
Starting DateRequired | date |
Selection Rules To Update | array |
Selection Rule IDRequired | text |
Delivery ProductRequired | choice |
Starting DateRequired | date |
Selection Rules To Delete | array |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Selection rule type | text |
Product selection list elements | array |
Configuration | object |
Reveal moment | text |
Pricing policy | text |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
EveryRequired | number |
Period TypeRequired | number |
Start DateRequired | date |
Next Order Date | date |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Rotating ProductRequired | choice |
OrdinalRequired | number |
Output fields
| Field | Type |
|---|---|
Ordinal | number |
Rotation product | text |
Subscription | text |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Extra Data | array |
Locale | text |
Price Code | text |
Output fields
| Field | Type |
|---|---|
Extra data | object |
Key | text |
Locale | text |
Input fields
| Field | Type |
|---|---|
AddressRequired | choice |
ActiveRequired | boolean |
Output fields
| Field | Type |
|---|---|
Customer | text |
Public ID | text |
Label | text |
First name | text |
Last name | text |
Company name | text |
Address | text |
Address 2 | text |
City | text |
State province code | text |
Zip postal code | text |
Phone | text |
Fax | text |
5other output fields
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
PriceRequired | number |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Subscription component | text |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
3other output fields
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
QuantityRequired | number |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Subscription component | text |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
3other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Extra DataRequired | array |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Autoship Enabled | boolean |
Prepaid Eligible | boolean |
Autoship By Default | boolean |
Upsell Eligible | boolean |
Price | number |
Product Type | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Merchant user ID | text |
Session ID | text |
User token ID | text |
First name | text |
Last name | text |
Email | |
Phone number | text |
Phone type | text |
Live | text |
Created | date |
Last updated | date |
Last login | date |
3other output fields
Input fields
| Field | Type |
|---|---|
ResourceRequired | choice |
Name | text |
Description | text |
Image URL | url |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Merchant | text |
Name | text |
External resource ID | text |
Description | text |
Image URL | url |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
ProductRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
EmailRequired | |
Phone NumberRequired | text |
Output fields
| Field | Type |
|---|---|
Phone number | text |
Email | |
Extra data | object |
Subscriber key | text |
Input fields
| Field | Type |
|---|---|
EntitlementRequired | choice |
Expiration DateRequired | date |
Output fields
| Field | Type |
|---|---|
Entitlement transaction | object |
Transaction type | text |
Public ID | text |
Entitlement public ID | text |
Merchant user ID | text |
Resource public ID | text |
Merchant public ID | text |
Transaction initiation time | text |
Transaction execution time | text |
Source action | text |
Source object | text |
Entitlement | object |
Merchant | text |
Public ID | text |
Merchant user ID | text |
Initial activation date | date |
Latest activation date | date |
Grace period | number |
Live | boolean |
Access type | text |
Expiration | date |
Created | date |
Renewal correction | object |
Success | boolean |
Updated order ids | array |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Free Trial IDRequired | text |
Duration (Days) | number |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Duration in days | number |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
ComponentsRequired | text |
Output fields
| Field | Type |
|---|---|
Order | text |
Offer | text |
Subscription | text |
Product | text |
Components | array |
Subscription component | text |
Quantity | number |
Public ID | text |
Product attribute | text |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
3other output fields
Input fields
| Field | Type |
|---|---|
One-Time IncentiveRequired | choice |
External Code | text |
Description | text |
Order | choice |
Item | choice |
Incentive | object |
Discount Type | choice |
Target | choice |
Name | text |
Value | text |
Gift Product ID | text |
Output fields
| Field | Type |
|---|---|
Public ID | text |
External code | text |
Description | text |
Merchant | text |
Customer | text |
Order | text |
Created | date |
Last updated | date |
Incentive | object |
Type | text |
Public ID | text |
Discount type | text |
Target | text |
Field | text |
Name | text |
Value | text |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
PaymentRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Place DateRequired | date |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Shipping AddressRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
ActiveRequired | boolean |
Output fields
| Field | Type |
|---|---|
Customer | text |
Billing address | text |
Cc number ending | text |
Public ID | text |
Label | text |
Token ID | text |
Cc holder | text |
Cc type | number |
Cc exp date | date |
Payment method | text |
Live | boolean |
Created | date |
Last updated | date |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Orders Per Billing | number |
Orders Remaining | number |
Renewal Behavior | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Raw subscription type | text |
Components | array |
Extra data | object |
Shopify contract ID | text |
Public ID | text |
Quantity | number |
Price | text |
21other output fields
Input fields
| Field | Type |
|---|---|
Group TypeRequired | choice |
New NameRequired | text |
Output fields
| Field | Type |
|---|---|
Name | text |
Group type | text |
Input fields
| Field | Type |
|---|---|
ItemRequired | choice |
ProductRequired | choice |
Output fields
| Field | Type |
|---|---|
Public ID | text |
Order | text |
Offer | text |
Subscription | text |
Subscription component | text |
Product | text |
Product attribute | text |
Quantity | number |
Price | text |
Extra cost | text |
Total price | text |
One time | boolean |
Order updated | date |
1other output field
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Shipping AddressRequired | text |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Components to Create | array |
ProductRequired | choice |
QuantityRequired | number |
Components to Update | array |
ComponentRequired | text |
Product | choice |
Quantity | number |
Components to Delete | array |
ComponentRequired | text |
Output fields
| Field | Type |
|---|---|
Created | array |
Updated | array |
Deleted | array |
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Reminder DaysRequired | number |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
EveryRequired | number |
Period TypeRequired | number |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
SubscriptionRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | text |
Customer | text |
Payment | text |
Shipping address | text |
Public ID | text |
Sub total | text |
Tax total | text |
Shipping total | text |
Discount total | text |
Total | text |
Created | date |
Place | date |
Cancelled | date |
9other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Next Order DateRequired | date |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Payment MethodRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Components | array |
Extra data | object |
Public ID | text |
Product attribute | text |
Quantity | number |
Price | text |
17other output fields
Input fields
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Orders Per BillingRequired | number |
Renewal Behavior | choice |
Offer | choice |
Output fields
| Field | Type |
|---|---|
Customer | text |
Merchant | text |
Product | text |
Payment | text |
Shipping address | text |
Offer | text |
Subscription type | text |
Raw subscription type | text |
Components | array |
Extra data | object |
Shopify contract ID | text |
Public ID | text |
Quantity | number |
Price | text |
21other output fields
Input fields
| Field | Type |
|---|---|
AddressRequired | choice |
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Input fields
| Field | Type |
|---|---|
EntitlementsRequired | choice |
Output fields
| Field | Type |
|---|---|
4e 9d 934275734a 859a 7f 8d 98dc 52c 8af | object |
Entitlement transaction | object |
Entitlement | object |
5289bf 2ad 76e 4fde 881ad 1a 89a 55b 5dc | object |
Entitlement transaction | object |
Entitlement | object |