About this integration
Payments, catalog, orders, and loyalty for in-person and online commerce. Use it from the workflow canvas with no custom glue script required.
This integration exposes 21 triggers, 61 search modules and 70 actions as workflow nodes. Authentication uses oauth authentication.
How to connect
The credential form asks for Client ID and Client Secret.
OAuth asks you to approve MERCHANT_PROFILE_READ, MERCHANT_PROFILE_WRITE, and PAYMENTS_READ before access is granted.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | Your application's Client ID (Application ID), from the Developer Dashboard OAuth page. |
Client SecretRequired | password | Your application's OAuth Client Secret, from the Developer Dashboard OAuth page. |
Permissions requested
- MERCHANT_PROFILE_READ
- MERCHANT_PROFILE_WRITE
- PAYMENTS_READ
- PAYMENTS_WRITE
- ORDERS_READ
- ORDERS_WRITE
- CUSTOMERS_READ
- CUSTOMERS_WRITE
- ITEMS_READ
- ITEMS_WRITE
- INVENTORY_READ
- INVENTORY_WRITE
- LOYALTY_READ
- LOYALTY_WRITE
- GIFTCARDS_READ
- GIFTCARDS_WRITE
- EMPLOYEES_READ
- EMPLOYEES_WRITE
- TIMECARDS_READ
- TIMECARDS_WRITE
- APPOINTMENTS_READ
- APPOINTMENTS_WRITE
- VENDOR_READ
- VENDOR_WRITE
- BANK_ACCOUNTS_READ
- CASH_DRAWER_READ
- DEVICE_CREDENTIAL_MANAGEMENT
- ONLINE_STORE_SITE_READ
- ONLINE_STORE_SNIPPETS_READ
- ONLINE_STORE_SNIPPETS_WRITE
Use it in workflow automation
Start with Watch Bookings, then add Accumulate Loyalty Points.
The canvas below runs Watch Bookings into Accumulate Loyalty Points — watch the video, then drop a node onto the canvas.
Select the Watch Transfer Orders trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create Order Custom Attribute Definition as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 91 ready-made modules for finance work — each run logs its inputs and outputs for debugging.
Square workflow on the canvas: Watch Transfer Orders then Create Order Custom Attribute Definition
Triggers, searches and actions
Use the tables below to inspect Square's 21 triggers, 61 search modules, and 70 actions.
Triggers
21 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Bookings
- Watch Cash Drawer Shift Events
- Watch Channels
- Watch Customer Groups
- Watch Customer Segments
16more triggers
Searches
Fetch data on demand using 61 search modules that query the app during a run.
- Get Payment
- Get Team Member Wage
- List Bookings
- List Cash Drawer Shift Events
- List Cash Drawer Shifts
56more searches
Actions
70 action modules cover the full range of create, update, and delete operations.
- Accumulate Loyalty Points
- Batch Change Inventory
- Batch Retrieve Inventory Changes
- Batch Retrieve Inventory Counts
- Batch Retrieve Orders
65more actions
Explore the fields available for each Square trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
3other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Event type | text |
Event money | object |
Amount | number |
Currency | text |
Created at | date |
Description | text |
Team member ID | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Merchant ID | text |
Name | text |
Status | text |
Version | number |
Reference | object |
Type | text |
ID | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Created at | date |
Data | object |
ID | text |
Object | object |
Type | text |
Event ID | text |
Location ID | text |
Merchant ID | text |
Type | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Location ID | text |
Created at | date |
Gift card ID | text |
Gift card GAN | text |
Gift card balance money | object |
Amount | number |
Currency | text |
Redeem activity details | object |
Amount money | object |
2other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
GAN source | text |
State | text |
Balance money | object |
Amount | number |
Currency | text |
GAN | text |
Created at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Address | object |
Address line 1 | text |
Locality | text |
Administrative district level 1 | text |
Postal code | text |
Country | text |
Timezone | text |
Capabilities | array |
Capabilities | text |
Status | text |
Created at | date |
Merchant ID | text |
5other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Mapping | object |
ID | text |
Phone number | text |
Created at | date |
Program ID | text |
Balance | number |
Lifetime points | number |
Customer ID | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Incentive | object |
Type | text |
Points multiplier data | object |
Available time | object |
Start date | text |
Time periods | array |
Trigger limit | object |
Times | number |
Interval | text |
Qualifying item variation ids | array |
Qualifying item variation ids | text |
Status | text |
Created at | date |
2other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Loyalty account ID | text |
Reward tier ID | text |
Points | number |
Order ID | text |
Created at | date |
Updated at | date |
1other output field
Output fields
| Field | Type |
|---|---|
ID | text |
Business name | text |
Country | text |
Language code | text |
Currency | text |
Status | text |
Main location ID | text |
Created at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Amount | number |
Currency | text |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Status | text |
Card | object |
Entry method | text |
CVV status | text |
AVS status | text |
Auth result code | text |
Statement description | text |
Card payment timeline | object |
14other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Draft shift details | object |
Team member ID | text |
Location ID | text |
Job ID | text |
Start at | date |
End at | date |
Notes | text |
Is deleted | boolean |
Timezone | text |
Version | number |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Site title | text |
Domain | text |
Is published | boolean |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | |
Created at | date |
3other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Team member ID | text |
Location ID | text |
Timezone | text |
Start at | date |
End at | date |
Wage | object |
Title | text |
Hourly rate | object |
Job ID | text |
Tip eligible | boolean |
Breaks | array |
ID | text |
Start at | date |
End at | date |
Break type ID | text |
Name | text |
Expected duration | text |
Is paid | boolean |
5other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
4other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Address line 1 | text |
Address line 2 | text |
Locality | text |
Administrative district level 1 | text |
Postal code | text |
Country | text |
Contacts | array |
ID | text |
Name | text |
Email address | |
Phone number | text |
Account number | text |
Note | text |
2other output fields
Searches
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Output fields
| Field | Type |
|---|---|
Payment | object |
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Location ID | text |
Order ID | text |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Team member wage | object |
ID | text |
Team member ID | text |
Title | text |
Hourly rate | object |
Job ID | text |
Tip eligible | boolean |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Team member ID | choice |
Location ID | choice |
Start at min | text |
Start at max | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
3other output fields
Input fields
| Field | Type |
|---|---|
ShiftRequired | choice |
Location IDRequired | choice |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Event type | text |
Event money | object |
Amount | number |
Currency | text |
Created at | date |
Description | text |
Team member ID | text |
Input fields
| Field | Type |
|---|---|
Location IDRequired | choice |
Sort order | text |
Begin time | date |
End time | date |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Opened at | date |
Ended at | date |
Closed at | date |
Description | text |
Opened cash money | object |
Amount | number |
Currency | text |
Expected cash money | object |
Amount | number |
Currency | text |
1other output field
Input fields
| Field | Type |
|---|---|
Types | text |
Catalog version | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Updated at | date |
Version | number |
Is deleted | boolean |
Present at all locations | boolean |
Category data | object |
Name | text |
Input fields
| Field | Type |
|---|---|
Reference type | object |
UNKNOWN type | object |
LOCATION | object |
FIRST party integration | object |
OAUTH application | object |
ONLINE site | object |
ONLINE checkout | object |
INVOICE | object |
GIFT card | object |
GIFT card marketplace | object |
RECURRING subscription | object |
Reference ID | text |
Status | object |
ACTIVE | object |
INACTIVE | object |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Merchant ID | text |
Name | text |
Status | text |
Version | number |
Reference | object |
Type | text |
ID | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
$ref | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
With definitions | boolean |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Version | number |
Updated at | date |
Value | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
API version | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Event types | array |
Event types | text |
Metadata | array |
Event type | text |
API version introduced | text |
Release status | text |
Input fields
| Field | Type |
|---|---|
Gift card ID | choice |
Type | text |
Location ID | choice |
Begin time | date |
End time | date |
Sort order | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Location ID | text |
Created at | date |
Gift card ID | text |
Gift card GAN | text |
Gift card balance money | object |
Amount | number |
Currency | text |
Redeem activity details | object |
Amount money | object |
2other output fields
Input fields
| Field | Type |
|---|---|
Type | text |
State | text |
Customer ID | choice |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
GAN source | text |
State | text |
Balance money | object |
Amount | number |
Currency | text |
GAN | text |
Created at | date |
Input fields
| Field | Type |
|---|---|
Include deleted | boolean |
Include system codes | boolean |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | object |
Type | text |
Direction | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Visibility filter | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
$ref | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Address | object |
Address line 1 | text |
Locality | text |
Administrative district level 1 | text |
Postal code | text |
Country | text |
Timezone | text |
Capabilities | array |
Capabilities | text |
Status | text |
Created at | date |
Merchant ID | text |
5other output fields
Input fields
| Field | Type |
|---|---|
ProgramRequired | choice |
Status | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Incentive | object |
Type | text |
Points multiplier data | object |
Available time | object |
Start date | text |
Time periods | array |
Trigger limit | object |
Times | number |
Interval | text |
Qualifying item variation ids | array |
Qualifying item variation ids | text |
Status | text |
Created at | date |
2other output fields
Input fields
| Field | Type |
|---|---|
Visibility filter | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
$ref | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Business name | text |
Country | text |
Language code | text |
Currency | text |
Status | text |
Main location ID | text |
Created at | date |
Input fields
| Field | Type |
|---|---|
Visibility filter | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
$ref | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Visibility filter | text |
With definitions | boolean |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Key | text |
Version | number |
Updated at | date |
Value | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
Begin time | date |
End time | date |
Sort order | text |
Location ID | choice |
Total | number |
Last 4 | text |
Card brand | text |
Is offline payment | boolean |
6other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Amount | number |
Currency | text |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Status | text |
Card | object |
Entry method | text |
CVV status | text |
AVS status | text |
Auth result code | text |
Statement description | text |
Card payment timeline | object |
14other output fields
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Site title | text |
Domain | text |
Is published | boolean |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Team member ID | choice |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Team member ID | text |
Title | text |
Hourly rate | object |
Amount | number |
Currency | text |
Job ID | text |
Tip eligible | boolean |
Input fields
| Field | Type |
|---|---|
BookingRequired | choice |
Output fields
| Field | Type |
|---|---|
Booking | object |
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
Seller note | text |
Start at | date |
Errors | array |
Input fields
| Field | Type |
|---|---|
ShiftRequired | choice |
Location IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Cash drawer shift | object |
ID | text |
State | text |
Opened at | date |
Ended at | date |
Closed at | date |
Opening team member ID | text |
Ending team member ID | text |
Closing team member ID | text |
Description | text |
Opened cash money | object |
Input fields
| Field | Type |
|---|---|
ChannelRequired | choice |
Output fields
| Field | Type |
|---|---|
Channel | object |
ID | text |
Merchant ID | text |
Name | text |
Status | text |
Version | number |
Reference | object |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Output fields
| Field | Type |
|---|---|
Group | object |
ID | text |
Name | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
SegmentRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Gift card | object |
ID | text |
Type | text |
GAN source | text |
State | text |
Balance money | object |
GAN | text |
Created at | date |
Input fields
| Field | Type |
|---|---|
AdjustmentRequired | choice |
Output fields
| Field | Type |
|---|---|
Errors | array |
Adjustment | object |
ID | text |
Reference ID | text |
From state | text |
To state | text |
Location ID | text |
Catalog object ID | text |
Catalog object type | text |
Quantity | text |
Total price money | object |
Occurred at | date |
Input fields
| Field | Type |
|---|---|
Catalog objectRequired | choice |
Location ids | choice |
Output fields
| Field | Type |
|---|---|
Errors | array |
Counts | array |
Catalog object ID | text |
Catalog object type | text |
State | text |
Location ID | text |
Quantity | text |
Calculated at | date |
Input fields
| Field | Type |
|---|---|
Physical countRequired | choice |
Input fields
| Field | Type |
|---|---|
JobRequired | choice |
Output fields
| Field | Type |
|---|---|
Job | object |
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Input fields
| Field | Type |
|---|---|
LocationRequired | choice |
Output fields
| Field | Type |
|---|---|
Location | object |
ID | text |
Name | text |
Address | object |
Timezone | text |
Capabilities | array |
Status | text |
Created at | date |
Merchant ID | text |
Country | text |
Language code | text |
Input fields
| Field | Type |
|---|---|
AccountRequired | choice |
Output fields
| Field | Type |
|---|---|
Loyalty account | object |
ID | text |
Mapping | object |
Program ID | text |
Balance | number |
Lifetime points | number |
Customer ID | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
ProgramRequired | choice |
Output fields
| Field | Type |
|---|---|
Loyalty promotion | object |
ID | text |
Name | text |
Incentive | object |
Available time | object |
Trigger limit | object |
Minimum spend amount money | object |
Qualifying item variation ids | array |
Status | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
RewardRequired | choice |
Output fields
| Field | Type |
|---|---|
Reward | object |
ID | text |
Status | text |
Loyalty account ID | text |
Reward tier ID | text |
Points | number |
Created at | date |
Updated at | date |
Redeemed at | date |
Input fields
| Field | Type |
|---|---|
MerchantRequired | choice |
Output fields
| Field | Type |
|---|---|
Merchant | object |
ID | text |
Business name | text |
Country | text |
Language code | text |
Currency | text |
Status | text |
Main location ID | text |
Created at | date |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Output fields
| Field | Type |
|---|---|
Order | object |
ID | text |
Location ID | text |
Line items | array |
Discounts | array |
Created at | date |
Updated at | date |
State | text |
Version | number |
Total tax money | object |
Total discount money | object |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Version | number |
With definition | boolean |
Output fields
| Field | Type |
|---|---|
Custom attribute | object |
Key | text |
Version | number |
Updated at | date |
Value | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
KeyRequired | choice |
Version | number |
Output fields
| Field | Type |
|---|---|
Custom attribute definition | object |
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Scheduled shift | object |
ID | text |
Draft shift details | object |
Version | number |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
SiteRequired | choice |
Output fields
| Field | Type |
|---|---|
Snippet | object |
ID | text |
Site ID | text |
Content | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Team memberRequired | choice |
Output fields
| Field | Type |
|---|---|
Team member | object |
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | |
Phone number | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Timecard | object |
ID | text |
Team member ID | text |
Location ID | text |
Timezone | text |
Start at | date |
End at | date |
Wage | object |
Breaks | array |
Declared cash tip money | object |
Status | text |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Created by team member ID | text |
Input fields
| Field | Type |
|---|---|
VendorRequired | choice |
Output fields
| Field | Type |
|---|---|
Vendor | object |
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Contacts | array |
Account number | text |
Note | text |
Version | number |
Status | text |
Input fields
| Field | Type |
|---|---|
QueryRequired | object |
FilterRequired | object |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Start at | date |
Location ID | text |
Appointment segments | array |
Duration minutes | number |
Team member ID | text |
Service variation ID | text |
Service variation version | number |
Input fields
| Field | Type |
|---|---|
Text filter | text |
Category ids | array |
Category ID | text |
Stock levels | array |
Enabled location ids | array |
Enabled location ID | text |
Limit | number |
Sort order | text |
Product types | object |
GIFT card | object |
Custom attribute filters | object |
Custom attribute definition ID | text |
Key | text |
String filter | text |
Number filter | object |
Selection uids filter | array |
Bool filter | boolean |
2other input fields
Output fields
| Field | Type |
|---|---|
Type | text |
ID | text |
Updated at | date |
Version | number |
Is deleted | boolean |
Present at all locations | boolean |
Custom attribute values | object |
VINTAGE | object |
VARIETAL | object |
BRAND | object |
Item data | object |
Name | text |
Product type | text |
Is archived | boolean |
Description | text |
Variations | array |
Input fields
| Field | Type |
|---|---|
Limit | number |
Query | object |
Filter | object |
Sort | object |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Created at | date |
Data | object |
ID | text |
Object | object |
Type | text |
Event ID | text |
Location ID | text |
Merchant ID | text |
Type | text |
Input fields
| Field | Type |
|---|---|
Query | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Mapping | object |
ID | text |
Phone number | text |
Created at | date |
Program ID | text |
Balance | number |
Lifetime points | number |
Customer ID | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Query | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Loyalty account ID | text |
Reward tier ID | text |
Points | number |
Order ID | text |
Created at | date |
Updated at | date |
1other output field
Input fields
| Field | Type |
|---|---|
Location ids | choice |
Query | object |
Limit | number |
Return entries | boolean |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Order ID | text |
Location ID | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Query | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Draft shift details | object |
Team member ID | text |
Location ID | text |
Job ID | text |
Start at | date |
End at | date |
Notes | text |
Is deleted | boolean |
Timezone | text |
Version | number |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Query | object |
Filter | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | |
Created at | date |
3other output fields
Input fields
| Field | Type |
|---|---|
Query | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Team member ID | text |
Location ID | text |
Timezone | text |
Start at | date |
End at | date |
Wage | object |
Title | text |
Hourly rate | object |
Job ID | text |
Tip eligible | boolean |
Breaks | array |
ID | text |
Start at | date |
End at | date |
Break type ID | text |
Name | text |
Expected duration | text |
Is paid | boolean |
5other output fields
Input fields
| Field | Type |
|---|---|
Query | object |
Limit | number |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
4other output fields
Input fields
| Field | Type |
|---|---|
Filter | object |
Name | array |
Status | array |
Sort | object |
Field | text |
Order | text |
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Address line 1 | text |
Address line 2 | text |
Locality | text |
Administrative district level 1 | text |
Postal code | text |
Country | text |
Contacts | array |
ID | text |
Name | text |
Email address | |
Phone number | text |
Account number | text |
Note | text |
2other output fields
Actions
Input fields
| Field | Type |
|---|---|
AccountRequired | choice |
Accumulate pointsRequired | object |
Idempotency key | text |
Location IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Events | array |
ID | text |
Type | text |
Created at | date |
Accumulate points | object |
Loyalty account ID | text |
Location ID | text |
Source | text |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Changes | array |
Ignore unchanged counts | boolean |
Output fields
| Field | Type |
|---|---|
Errors | array |
Counts | array |
Catalog object ID | text |
Catalog object type | text |
State | text |
Location ID | text |
Quantity | text |
Calculated at | date |
Input fields
| Field | Type |
|---|---|
Catalog object ids | array |
Catalog object ID | text |
Location ids | choice |
Types | array |
States | array |
Updated after | text |
Updated before | text |
Limit | number |
Sort | object |
1other input field
Output fields
| Field | Type |
|---|---|
Errors | array |
Changes | array |
Type | text |
Physical count | object |
Input fields
| Field | Type |
|---|---|
Catalog object ids | array |
Catalog object ID | text |
Location ids | choice |
Updated after | text |
States | array |
Limit | number |
Output fields
| Field | Type |
|---|---|
Errors | array |
Counts | array |
Catalog object ID | text |
Catalog object type | text |
State | text |
Location ID | text |
Quantity | text |
Calculated at | date |
Input fields
| Field | Type |
|---|---|
Location ID | choice |
Order idsRequired | array |
Order ID | text |
Output fields
| Field | Type |
|---|---|
Orders | array |
ID | text |
Location ID | text |
Reference ID | text |
Line items | array |
Total money | object |
Input fields
| Field | Type |
|---|---|
Team membersRequired | array |
Output fields
| Field | Type |
|---|---|
Team members | object |
Idempotency-key-1 | object |
Idempotency-key-2 | object |
Input fields
| Field | Type |
|---|---|
VendorsRequired | array |
Output fields
| Field | Type |
|---|---|
Responses | object |
8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe | object |
47bb76a8-c9fb-4f33-9df8-25ce02ca4505 | object |
Vendor | object |
Input fields
| Field | Type |
|---|---|
Booking idsRequired | array |
Booking ID | text |
Output fields
| Field | Type |
|---|---|
Bookings | object |
Sc3p3m7dvctfr1 | object |
Tdegug1dvctdef | object |
Tdegug1fqni3wh | object |
Errors | array |
Input fields
| Field | Type |
|---|---|
Channel idsRequired | array |
Channel ID | text |
Output fields
| Field | Type |
|---|---|
Responses | object |
CH 9c03d0b59 | object |
CH 6x139b5mn | object |
NOT existing | object |
Input fields
| Field | Type |
|---|---|
Vendor ids | array |
Vendor ID | text |
Input fields
| Field | Type |
|---|---|
Team membersRequired | array |
Output fields
| Field | Type |
|---|---|
Team members | object |
FpgteZNMaf0qOK-a4t6P | object |
AFMwA08kR-MIF-3Vs0OE | object |
Input fields
| Field | Type |
|---|---|
VendorsRequired | array |
Output fields
| Field | Type |
|---|---|
Responses | object |
INV v jdkyhbwt1d4f8mfh63dbmen8y4 | object |
INV v fmcyhbwt1tpl8mfh52pbmen92a | object |
Input fields
| Field | Type |
|---|---|
ProgramRequired | choice |
Order ID | choice |
Transaction amount money | object |
Loyalty account ID | choice |
Output fields
| Field | Type |
|---|---|
Points | number |
Promotion points | number |
Input fields
| Field | Type |
|---|---|
OrderRequired | object |
Proposed rewards | array |
Output fields
| Field | Type |
|---|---|
Order | object |
Location ID | text |
Line items | array |
Discounts | array |
Created at | date |
Updated at | date |
State | text |
Version | number |
Total tax money | object |
Total discount money | object |
Total tip money | object |
Input fields
| Field | Type |
|---|---|
BookingRequired | choice |
Idempotency key | text |
Booking version | number |
Output fields
| Field | Type |
|---|---|
Booking | object |
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
Seller note | text |
Start at | date |
Errors | array |
Input fields
| Field | Type |
|---|---|
ProgramRequired | choice |
Output fields
| Field | Type |
|---|---|
Loyalty promotion | object |
ID | text |
Name | text |
Incentive | object |
Available time | object |
Trigger limit | object |
Minimum spend amount money | object |
Qualifying category ids | array |
Status | text |
Created at | date |
Canceled at | date |
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Output fields
| Field | Type |
|---|---|
Payment | object |
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Tip money | object |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Location ID | text |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Idempotency key | text |
Version | number |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Completed at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Output fields
| Field | Type |
|---|---|
Limits | object |
Batch upsert max objects per batch | number |
Batch upsert max total objects | number |
Batch retrieve max object ids | number |
Search max page limit | number |
Batch delete max object ids | number |
Update item taxes max item ids | number |
Update item taxes max taxes to enable | number |
Update item taxes max taxes to disable | number |
Update item modifier lists max item ids | number |
Update item modifier lists max modifier lists to enable | number |
Input fields
| Field | Type |
|---|---|
Order IDRequired | choice |
Version | number |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Order | object |
ID | text |
Location ID | text |
Line items | array |
Taxes | array |
Discounts | array |
Created at | date |
Updated at | date |
State | text |
Version | number |
Reference ID | text |
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Version token | text |
Output fields
| Field | Type |
|---|---|
Payment | object |
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Location ID | text |
Order ID | text |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
BookingRequired | object |
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Start at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
Seller note | text |
Output fields
| Field | Type |
|---|---|
Booking | object |
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
Seller note | text |
Start at | date |
Errors | array |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
GroupRequired | object |
ID | text |
NameRequired | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Group | object |
ID | text |
Name | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Location IDRequired | choice |
Gift cardRequired | object |
ID | text |
TypeRequired | text |
GAN source | text |
State | text |
Balance money | object |
GAN | text |
Created at | date |
Customer ids | array |
Output fields
| Field | Type |
|---|---|
Gift card | object |
ID | text |
Type | text |
GAN source | text |
State | text |
Balance money | object |
GAN | text |
Created at | date |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Gift card activityRequired | object |
ID | text |
TypeRequired | text |
Location IDRequired | text |
Created at | date |
Gift card ID | text |
Gift card GAN | text |
Gift card balance money | object |
Load activity details | object |
Activate activity details | object |
Redeem activity details | object |
Output fields
| Field | Type |
|---|---|
Gift card activity | object |
ID | text |
Gift card ID | text |
Gift card GAN | text |
Type | text |
Gift card balance money | object |
Location ID | text |
Created at | date |
Activate activity details | object |
Input fields
| Field | Type |
|---|---|
JobRequired | object |
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Job | object |
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Location | object |
ID | text |
Name | text |
Address | object |
Timezone | date |
Capabilities | array |
Status | text |
Created at | date |
Merchant ID | text |
Country | text |
Language code | text |
Output fields
| Field | Type |
|---|---|
Location | object |
ID | text |
Name | text |
Address | object |
Timezone | text |
Capabilities | array |
Status | text |
Created at | date |
Merchant ID | text |
Country | text |
Language code | text |
Input fields
| Field | Type |
|---|---|
Loyalty accountRequired | object |
ID | text |
Program IDRequired | text |
Balance | number |
Lifetime points | number |
Customer ID | text |
Enrolled at | date |
Created at | date |
Updated at | date |
Mapping | object |
Expiring point deadlines | array |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Loyalty account | object |
ID | text |
Mapping | object |
Program ID | text |
Balance | number |
Lifetime points | number |
Customer ID | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
ProgramRequired | choice |
Loyalty promotionRequired | object |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Loyalty promotion | object |
ID | text |
Name | text |
Incentive | object |
Available time | object |
Trigger limit | object |
Minimum spend amount money | object |
Status | text |
Created at | date |
Updated at | date |
Loyalty program ID | text |
Input fields
| Field | Type |
|---|---|
RewardRequired | object |
ID | text |
Status | text |
Loyalty account IDRequired | text |
Reward tier IDRequired | text |
Points | number |
Order ID | text |
Created at | date |
Updated at | date |
Redeemed at | date |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Reward | object |
ID | text |
Status | text |
Loyalty account ID | text |
Reward tier ID | text |
Points | number |
Order ID | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Custom attribute definitionRequired | object |
Key | text |
Schema | text |
Name | text |
Description | text |
Visibility | text |
Version | number |
Updated at | date |
Created at | date |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Custom attribute definition | object |
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
Source IDRequired | text |
Idempotency key | text |
Amount money | object |
Amount | number |
Currency | text |
Tip money | object |
Amount | number |
Currency | text |
App fee money | object |
Amount | number |
Currency | text |
Delay duration | text |
Delay action | text |
Autocomplete | boolean |
17other input fields
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Scheduled shiftRequired | object |
ID | text |
Draft shift details | object |
Published shift details | object |
Version | number |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Scheduled shift | object |
ID | text |
Draft shift details | object |
Version | number |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Team member | object |
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | text |
Phone number | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Team member | object |
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | |
Phone number | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
TimecardRequired | object |
ID | text |
Location IDRequired | text |
Timezone | date |
Start atRequired | date |
End at | date |
Wage | object |
Breaks | array |
Status | text |
Version | number |
Created at | date |
Output fields
| Field | Type |
|---|---|
Timecard | object |
ID | text |
Team member ID | text |
Location ID | text |
Timezone | text |
Start at | date |
End at | date |
Wage | object |
Breaks | array |
Declared cash tip money | object |
Status | text |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Transfer orderRequired | object |
Source location IDRequired | text |
Destination location IDRequired | text |
Expected at | date |
Notes | text |
Tracking number | text |
Created by team member ID | text |
Line items | array |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Created by team member ID | text |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
Vendor | object |
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Contacts | array |
Account number | text |
Note | text |
Version | number |
Status | text |
Output fields
| Field | Type |
|---|---|
Vendor | object |
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Contacts | array |
Account number | text |
Note | text |
Version | number |
Status | text |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
Input fields
| Field | Type |
|---|---|
RewardRequired | choice |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Input fields
| Field | Type |
|---|---|
KeyRequired | choice |
Input fields
| Field | Type |
|---|---|
SiteRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Version | number |
No fields documented.
No fields documented.
Input fields
| Field | Type |
|---|---|
URLRequired | text |
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 |
|---|---|
OrderRequired | choice |
Idempotency key | text |
Order version | number |
Payment ids | array |
Payment ID | text |
Output fields
| Field | Type |
|---|---|
Order | object |
ID | text |
Location ID | text |
Line items | array |
Created at | date |
Updated at | date |
Version | number |
Total tax money | object |
Total discount money | object |
Total money | object |
Closed at | date |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Idempotency key | text |
Version | number |
Scheduled shift notification audience | object |
ALL | object |
AFFECTED | object |
NONE | object |
Output fields
| Field | Type |
|---|---|
Scheduled shift | object |
ID | text |
Draft shift details | object |
Published shift details | object |
Version | number |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Idempotency key | text |
ReceiptRequired | object |
Version | number |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Completed at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Input fields
| Field | Type |
|---|---|
RewardRequired | choice |
Idempotency key | text |
Location IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Event | object |
ID | text |
Type | text |
Created at | date |
Redeem reward | object |
Loyalty account ID | text |
Location ID | text |
Source | text |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Idempotency key | text |
Version | number |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Created by team member ID | text |
Input fields
| Field | Type |
|---|---|
BookingRequired | choice |
Idempotency key | text |
BookingRequired | object |
Output fields
| Field | Type |
|---|---|
Booking | object |
ID | text |
Version | number |
Status | text |
Created at | date |
Updated at | date |
Location ID | text |
Customer ID | text |
Customer note | text |
Seller note | text |
Start at | date |
Errors | array |
Input fields
| Field | Type |
|---|---|
GroupRequired | choice |
GroupRequired | object |
ID | text |
NameRequired | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Group | object |
ID | text |
Name | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Idempotency key | text |
AdjustmentRequired | object |
ID | text |
Reference ID | text |
From state | text |
To state | text |
From location ID | text |
To location ID | text |
Catalog object ID | text |
Catalog object type | text |
Quantity | text |
Total price money | object |
Output fields
| Field | Type |
|---|---|
Errors | array |
Adjustment | object |
ID | text |
Reference ID | text |
From state | text |
To state | text |
Location ID | text |
Catalog object ID | text |
Catalog object type | text |
Quantity | text |
Total price money | object |
Occurred at | date |
Input fields
| Field | Type |
|---|---|
Item idsRequired | array |
Item ID | text |
Modifier lists to enable | array |
Modifier lists to enable | text |
Modifier lists to disable | array |
Modifier lists to disable | text |
Output fields
| Field | Type |
|---|---|
Updated at | date |
Input fields
| Field | Type |
|---|---|
Item idsRequired | array |
Item ID | text |
Taxes to enable | array |
Taxes to enable | text |
Taxes to disable | array |
Taxes to disable | text |
Output fields
| Field | Type |
|---|---|
Updated at | date |
Input fields
| Field | Type |
|---|---|
JobRequired | choice |
JobRequired | object |
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Output fields
| Field | Type |
|---|---|
Job | object |
ID | text |
Title | text |
Is tip eligible | boolean |
Created at | date |
Updated at | date |
Version | number |
Input fields
| Field | Type |
|---|---|
LocationRequired | choice |
Location | object |
Output fields
| Field | Type |
|---|---|
Location | object |
ID | text |
Name | text |
Address | object |
Timezone | text |
Capabilities | array |
Status | text |
Created at | date |
Merchant ID | text |
Country | text |
Language code | text |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Order | object |
Fields to clear | array |
Fields to clear | text |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Order | object |
Version | number |
Total money | object |
Source | object |
Line items | array |
State | text |
Total service charge money | object |
ID | text |
Location ID | text |
Total tax money | object |
Created at | date |
Input fields
| Field | Type |
|---|---|
KeyRequired | choice |
Custom attribute definitionRequired | object |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Custom attribute definition | object |
Key | text |
Name | text |
Description | text |
Version | number |
Updated at | date |
Schema | object |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
PaymentRequired | choice |
Payment | object |
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Tip money | object |
Total money | object |
App fee money | object |
Approved money | object |
Processing fee | array |
Refunded money | object |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Payment | object |
ID | text |
Created at | date |
Updated at | date |
Amount money | object |
Tip money | object |
Status | text |
Delay duration | text |
Source type | text |
Card details | object |
Location ID | text |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Scheduled shiftRequired | object |
Output fields
| Field | Type |
|---|---|
Scheduled shift | object |
ID | text |
Draft shift details | object |
Version | number |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
Team memberRequired | choice |
Team member | object |
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | text |
Phone number | text |
Created at | date |
Updated at | date |
Output fields
| Field | Type |
|---|---|
Team member | object |
ID | text |
Reference ID | text |
Is owner | boolean |
Status | text |
Given name | text |
Family name | text |
Email address | |
Phone number | text |
Created at | date |
Updated at | date |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
TimecardRequired | object |
ID | text |
Location IDRequired | text |
Timezone | date |
Start atRequired | date |
End at | date |
Wage | object |
Breaks | array |
Status | text |
Version | number |
Created at | date |
Output fields
| Field | Type |
|---|---|
Timecard | object |
ID | text |
Team member ID | text |
Location ID | text |
Timezone | text |
Start at | date |
End at | date |
Wage | object |
Breaks | array |
Declared cash tip money | object |
Status | text |
Input fields
| Field | Type |
|---|---|
Transfer orderRequired | choice |
Idempotency key | text |
Transfer orderRequired | object |
Version | number |
Output fields
| Field | Type |
|---|---|
Transfer order | object |
ID | text |
Source location ID | text |
Destination location ID | text |
Status | text |
Created at | date |
Updated at | date |
Expected at | date |
Notes | text |
Tracking number | text |
Created by team member ID | text |
Input fields
| Field | Type |
|---|---|
VendorRequired | choice |
Idempotency key | text |
VendorRequired | object |
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Contacts | array |
Account number | text |
Note | text |
Version | number |
Status | text |
Output fields
| Field | Type |
|---|---|
Vendor | object |
ID | text |
Created at | date |
Updated at | date |
Name | text |
Address | object |
Contacts | array |
Account number | text |
Version | number |
Status | text |
Input fields
| Field | Type |
|---|---|
OrderRequired | choice |
Custom attributeRequired | object |
Idempotency key | text |
Output fields
| Field | Type |
|---|---|
Custom attribute | object |
Key | text |
Version | number |
Updated at | date |
Value | text |
Created at | date |
Visibility | text |
Input fields
| Field | Type |
|---|---|
SiteRequired | choice |
SnippetRequired | object |
Output fields
| Field | Type |
|---|---|
Snippet | object |
ID | text |
Site ID | text |
Content | text |
Created at | date |
Updated at | date |