About this integration
Connect your retail point-of-sale system to automate inventory, sales, and customer data synchronization. Connect it to any workflow without writing code.
You can choose from 3 triggers, 69 search modules and 71 actions. The connection type is oauth authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Client ID and Client Secret.
OAuth asks you to approve audit:read, business_rules:read, and business_rules:write 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 | The Client ID from your (X-Series) developer app registration. |
Client SecretRequired | password | The Client Secret from your (X-Series) developer app registration. |
Permissions requested
- audit:read
- business_rules:read
- business_rules:write
- channels:read
- consignments:read
- consignments:write:inventory_count
- consignments:write:stock_order
- consignments:write:stock_transfer
- custom_fields:read
- custom_fields:write
- customers:read
- customers:write
- fulfillments:read
- fulfillments:write
- gift_cards:read
- gift_cards:write:issue
- gift_cards:write:redeem
- inventory:read
- inventory:write
- outlets:read
- payments:read
- payment_types:read
- products:read
- products:read:price_books
- products:write
- products:write:price_books
- promotions:read
- promotions:write
- register:close
- register:open
- registers:read
- remote_rules:read
- remote_rules:write
- retailer:read
- sales:read
- sales:write
- serial_numbers:read
- serial_numbers:write
- services:read
- services:write
- store_credits:read
- store_credits:write:issue
- store_credits:write:redeem
- suppliers:read
- suppliers:write
- taxes:read
- taxes:write
- users:read
- users:write
- webhooks
Use it in workflow automation
Start with Watch Customers, then add Add Consignment Product.
Triggers, searches and actions
Explore the fields available for each Lightspeed Retail trigger, search, and action — 3 triggers, 69 searchs, and 71 actions.
Triggers
Whenever something changes in the app, one of 3 available triggers can start a run immediately.
- Watch Customers
- Watch Products
- Watch Sales
Searches
69 search modules let you query the app mid-run and feed the results to the next step.
- Get Brand
- Get Button Layout
- Get Consignment
- Get Consignment Totals
- Get Customer
64more searches
Actions
Use 71 action modules to write data back into the app from anywhere in a run.
- Add Consignment Product
- Add Customers To Customer Group
- Add Price Book Products
- Bulk List Store Credit
- Bulk List Store Credit Balances
66more actions
Explore the fields available for each Lightspeed Retail trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Customer ID | text |
Retailer ID | text |
Customer code | text |
Customer group ID | text |
First name | text |
Last name | text |
Company name | text |
Do not email | boolean |
24other output fields
Output fields
| Field | Type |
|---|---|
Product ID | text |
Retailer ID | text |
SKU | text |
Handle | text |
Name | text |
Base name | text |
Description | text |
Active | boolean |
17other output fields
Output fields
| Field | Type |
|---|---|
Sale ID | text |
Invoice number | text |
Short code | text |
Status | text |
Source | text |
Source ID | text |
Note | text |
Sale date | date |
13other output fields
Searches
Input fields
| Field | Type |
|---|---|
BrandRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Button Layout IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Nodes | array |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Status | text |
Outlet ID | text |
Source Outlet ID | text |
Supplier ID | text |
Supplier Invoice | text |
12other output fields
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
Output fields
| Field | Type |
|---|---|
Total Sent Cost | text |
Total Sent Count | text |
Total Received Cost | text |
Total Received Count | text |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Address IDRequired | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Customer ID | text |
Type | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
Suburb | text |
State | text |
6other output fields
Input fields
| Field | Type |
|---|---|
Customer GroupRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Group ID | text |
Retailer ID | text |
Created At | date |
Updated At | date |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer ID | text |
Balance | number |
Total Credit Issued | number |
Total Credit Redeemed | number |
Created At | date |
Recent Transactions | array |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer ID | text |
Balance | number |
Total Credit Issued | number |
Total Credit Redeemed | number |
Input fields
| Field | Type |
|---|---|
Fulfillment IDRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Sale Line Item ID | text |
Product ID | text |
Event Type | text |
Quantity Delta | text |
Picked Quantity Delta | text |
Packed Quantity Delta | text |
Fulfilled Delta | text |
Created At | date |
1other output field
Input fields
| Field | Type |
|---|---|
Limit | number |
Outlets | array |
Outlet | choice |
Sales | array |
Sale | choice |
Fulfillment Types | array |
Type | choice |
Fulfillment States | array |
State | choice |
Output fields
| Field | Type |
|---|---|
Fulfillment ID | text |
Sale ID | text |
Outlet ID | text |
Type | text |
State | text |
Note | text |
Shipping Address ID | text |
Created At | date |
4other output fields
Input fields
| Field | Type |
|---|---|
OutletRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Currency | text |
Currency Symbol | text |
Default Tax ID | text |
Display Prices | text |
Email | text |
Phone | text |
13other output fields
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Platform Restriction Key | text |
Platform Restriction Label | text |
Customer Groups | array |
Outlets | array |
Version | number |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
SKU | text |
Description | text |
Handle | text |
Active | boolean |
Is Composite | boolean |
Has Variants | boolean |
24other output fields
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | text |
Output fields
| Field | Type |
|---|---|
Image ID | text |
Product ID | text |
Position | number |
Status | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Product Type IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Purchase Order IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Order Number | text |
Status | text |
Notes | text |
Delivery Outlet ID | text |
Allocation Outlet IDs | array |
Supplier ID | text |
Supplier Invoice | text |
9other output fields
Input fields
| Field | Type |
|---|---|
Quote IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Short Code | text |
Customer ID | text |
Outlet ID | text |
Register ID | text |
User ID | text |
Retailer ID | text |
11other output fields
Input fields
| Field | Type |
|---|---|
RegisterRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Outlet ID | text |
Is Open | boolean |
Register Open Time | date |
Register Close Time | date |
Invoice Prefix | text |
Invoice Suffix | text |
13other output fields
Input fields
| Field | Type |
|---|---|
RegisterRequired | choice |
Output fields
| Field | Type |
|---|---|
Payments | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Domain Prefix | text |
Country | text |
Culture | text |
Timezone | text |
Currency | object |
Code | text |
Symbol | text |
Account Status | text |
16other output fields
Input fields
| Field | Type |
|---|---|
Sale IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Short Code | text |
Invoice Number | text |
Receipt Number | text |
Note | text |
Customer ID | text |
Sale Date | date |
12other output fields
Output fields
| Field | Type |
|---|---|
Outstanding Balance | number |
Total Value Issued | number |
Total Value Redeemed | number |
Input fields
| Field | Type |
|---|---|
SupplierRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Default Markup | number |
Source | text |
Version | number |
Deleted At | date |
Contact | object |
Company Name | text |
Email | text |
Fax | text |
First Name | text |
Last Name | text |
Mobile | text |
Phone | text |
Physical Address 1 | text |
Physical Address 2 | text |
Physical City | text |
Input fields
| Field | Type |
|---|---|
TagRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Tax IDRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Display Name | text |
Is Default | boolean |
Rates | array |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Variant AttributeRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Deleted At | date |
Input fields
| Field | Type |
|---|---|
WebhookRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Retailer ID | text |
Active | boolean |
Type | text |
URL | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Version | number |
Deleted At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Nodes | array |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product SKU | text |
Expected Count | text |
Received Count | text |
Cost | text |
Status | text |
Is Included | boolean |
Created At | date |
3other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Type | choice |
Status | choice |
Outlet | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Status | text |
Outlet ID | text |
Source Outlet ID | text |
Supplier ID | text |
Supplier Invoice | text |
12other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | number |
Customer ID | text |
Type | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
Suburb | text |
State | text |
6other output fields
Input fields
| Field | Type |
|---|---|
Customer GroupRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
First Name | text |
Last Name | text |
Company Name | text |
Customer Code | text |
Customer Group ID | text |
Email | text |
38other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Group ID | text |
Retailer ID | text |
Created At | date |
Updated At | date |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
First Name | text |
Last Name | text |
Company Name | text |
Customer Code | text |
Customer Group ID | text |
Email | text |
38other output fields
Input fields
| Field | Type |
|---|---|
Entity TypeRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Entity Type | text |
Value Type | text |
Editable In UI | boolean |
Visible In UI | boolean |
Created At | date |
Input fields
| Field | Type |
|---|---|
Entity TypeRequired | choice |
Entity IDRequired | text |
Output fields
| Field | Type |
|---|---|
Custom Field Definition ID | text |
Name | text |
Title | text |
Value Type | text |
String Value | text |
Integer Value | number |
Boolean Value | boolean |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Enabled | boolean |
Type | text |
Created Via API | boolean |
Version | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Outlets | choice |
Products | choice |
Root Products | choice |
Suppliers | choice |
Group Variants | boolean |
Include Composites | boolean |
Include Inactive | boolean |
3other input fields
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product Name | text |
Outlet ID | text |
Root Product ID | text |
Brand ID | text |
Product Type ID | text |
Supplier ID | text |
Current Inventory Level | number |
7other output fields
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Limit | number |
Include Inactive | boolean |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product Name | text |
Outlet ID | text |
Root Product ID | text |
Brand ID | text |
Product Type ID | text |
Supplier ID | text |
Current Inventory Level | number |
7other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Product | choice |
Include Variants | boolean |
Include Deleted | boolean |
Sort Direction | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Outlet ID | text |
Current Inventory Level | number |
Average Cost | number |
Quantity To Procure | number |
Reorder Method | text |
Reorder Point | number |
4other output fields
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Limit | number |
Include Variants | boolean |
Include Deleted | boolean |
Order Direction | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Outlet ID | text |
Current Inventory Level | number |
Average Cost | number |
Quantity To Procure | number |
Reorder Method | text |
Reorder Point | number |
4other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Outlet | choice |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
Outlet ID | text |
Product ID | text |
Tax ID | text |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Currency | text |
Currency Symbol | text |
Default Tax ID | text |
Display Prices | text |
Email | text |
Phone | text |
13other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Outlet | choice |
Currency | text |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Name Changed By User | boolean |
Global Payment Type ID | number |
Global Payment Type | object |
ID | number |
Name | text |
Category | text |
Subcategory | text |
Description | text |
Internal | boolean |
Online Only | boolean |
Disabled | boolean |
Gateway | boolean |
Internal | boolean |
6other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Price Book ID | text |
Product ID | text |
Price | number |
Tax ID | text |
Loyalty Value | number |
Min Units | number |
Max Units | number |
3other output fields
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
Limit | number |
Filter by Product IDs | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Price Book ID | text |
Product ID | text |
Price | number |
Tax ID | text |
Loyalty Value | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Customer Group ID | text |
Sort Field | text |
Sort Direction | choice |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Platform Restriction Key | text |
Platform Restriction Label | text |
Customer Groups | array |
Outlets | array |
Version | number |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Price Book ID | text |
Product ID | text |
Default Display Price | number |
Adjustment | number |
Adjustment Type | text |
Discount | number |
Loyalty Value | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Parent Category ID | text |
Include | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Full Path Name | text |
Parent Category ID | text |
Category Path | array |
Input fields
| Field | Type |
|---|---|
Limit | number |
SKU | text |
Brand | choice |
Supplier | choice |
Tag | choice |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
SKU | text |
Description | text |
Handle | text |
Active | boolean |
Is Composite | boolean |
Has Variants | boolean |
17other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Purchase Order IDRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Purchase Order ID | text |
Outlet ID | text |
Status | text |
Notes | text |
User ID | text |
Supplier Invoice | text |
Received Quantity Total | text |
9other output fields
Input fields
| Field | Type |
|---|---|
Purchase Order IDRequired | text |
Delivery IDRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Purchase Order Delivery ID | text |
Purchase Order Line Item ID | text |
Product ID | text |
Expected Quantity | text |
Received Quantity | text |
Cost Price | text |
Allocations | array |
4other output fields
Input fields
| Field | Type |
|---|---|
Purchase Order IDRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Purchase Order ID | text |
Product ID | text |
Quantity | text |
Cost Price | text |
Allocations | array |
Components | array |
Created At | date |
2other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Order Number | text |
Status | text |
Notes | text |
Delivery Outlet ID | text |
Allocation Outlet IDs | array |
Supplier ID | text |
Supplier Invoice | text |
9other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Short Code | text |
Customer ID | text |
Outlet ID | text |
Register ID | text |
User ID | text |
Retailer ID | text |
11other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Outlet ID | text |
Is Open | boolean |
Register Open Time | date |
Register Close Time | date |
Invoice Prefix | text |
Invoice Suffix | text |
13other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Short Code | text |
Invoice Number | text |
Receipt Number | text |
Note | text |
Customer ID | text |
Sale Date | date |
12other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Outlet ID | text |
User ID | text |
Quantity | text |
Reason | text |
Custom Reason ID | text |
Version | number |
2other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Customer Details | boolean |
Output fields
| Field | Type |
|---|---|
Store Credit Customer ID | text |
Customer ID | text |
Balance | number |
Total Credit Issued | number |
Total Credit Redeemed | number |
Created At | date |
Recent Transactions | array |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
Default Markup | number |
Source | text |
Version | number |
Deleted At | date |
Contact | object |
Company Name | text |
Email | text |
Fax | text |
First Name | text |
Last Name | text |
Mobile | text |
Phone | text |
Physical Address 1 | text |
Physical Address 2 | text |
Physical City | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Version | number |
Deleted At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Display Name | text |
Is Default | boolean |
Rates | array |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Limit | number |
Include Deleted | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Deleted At | date |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Retailer ID | text |
Active | boolean |
Type | text |
URL | text |
Input fields
| Field | Type |
|---|---|
Resource TypeRequired | choice |
Limit | number |
Sort By | text |
Sort Direction | choice |
Filters | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Full Result | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Date From | date |
Date To | date |
Time From | text |
Time To | text |
Timezone | text |
State | choice |
Attributes | array |
Attribute | choice |
11other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Short Code | text |
Invoice Number | text |
Receipt Number | text |
Note | text |
Customer ID | text |
Sale Date | date |
12other output fields
Actions
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
ProductRequired | choice |
Expected Count | text |
Received Count | text |
Cost | text |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product SKU | text |
Expected Count | text |
Received Count | text |
Cost | text |
Status | text |
Is Included | boolean |
Created At | date |
3other output fields
Input fields
| Field | Type |
|---|---|
Customer GroupRequired | choice |
CustomersRequired | choice |
Output fields
| Field | Type |
|---|---|
Result | boolean |
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
ProductsRequired | array |
Output fields
| Field | Type |
|---|---|
Price Book Products | array |
Input fields
| Field | Type |
|---|---|
Customer IDsRequired | array |
Output fields
| Field | Type |
|---|---|
Store Credit Customer ID | text |
Customer ID | text |
Balance | number |
Total Credit Issued | number |
Total Credit Redeemed | number |
Created At | date |
Recent Transactions | array |
Input fields
| Field | Type |
|---|---|
Customer IDsRequired | array |
Output fields
| Field | Type |
|---|---|
Customer ID | text |
Balance | number |
Total Credit Issued | number |
Total Credit Redeemed | number |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
ProductsRequired | array |
Product | object |
Output fields
| Field | Type |
|---|---|
Updated Products | object |
Input fields
| Field | Type |
|---|---|
RegisterRequired | choice |
Payments | array |
Payment | object |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Outlet ID | text |
Is Open | boolean |
Register Open Time | date |
Register Close Time | date |
Invoice Prefix | text |
Invoice Suffix | text |
13other output fields
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Output fields
| Field | Type |
|---|---|
Brand ID | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
OutletRequired | choice |
TypeRequired | choice |
Supplier | choice |
Source Outlet | choice |
Supplier Invoice | text |
Due Date | date |
Consignment Date | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Status | text |
Outlet ID | text |
Source Outlet ID | text |
Supplier ID | text |
Supplier Invoice | text |
12other output fields
Input fields
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
Company Name | text |
Customer Code | text |
Customer Group | choice |
Email | |
Phone | text |
Mobile | text |
29other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
First Name | text |
Last Name | text |
Company Name | text |
Customer Code | text |
Customer Group ID | text |
Email | text |
38other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Address Line 1Required | text |
CityRequired | text |
PostcodeRequired | text |
Country CodeRequired | text |
TypeRequired | choice |
Address Line 2 | text |
Suburb | text |
2other input fields
Output fields
| Field | Type |
|---|---|
ID | number |
Customer ID | text |
Type | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
Suburb | text |
State | text |
7other output fields
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Group ID | text |
Retailer ID | text |
Created At | date |
Updated At | date |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Entity TypeRequired | choice |
NameRequired | text |
TitleRequired | text |
Value TypeRequired | choice |
Editable In UI | boolean |
Visible In UI | boolean |
Print On Receipt | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Entity Type | text |
Value Type | text |
Editable In UI | boolean |
Visible In UI | boolean |
Created At | date |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
EnabledRequired | boolean |
TypeRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Enabled | boolean |
Type | text |
Created Via API | boolean |
Version | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
CategoriesRequired | array |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Customer Group IDsRequired | array |
OutletsRequired | choice |
Restrict To Platform | choice |
Valid From | date |
Valid To | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Name | text |
SKU | text |
Description | text |
Brand | choice |
Supplier | choice |
Supplier Code | text |
Supply Price | number |
Product Category ID | text |
14other input fields
Output fields
| Field | Type |
|---|---|
Product ID | text |
Input fields
| Field | Type |
|---|---|
StateRequired | choice |
SourceRequired | object |
Author (Cashier)Required | choice |
Register | choice |
External Source ID | text |
External System Type | text |
Customer | choice |
Fulfillment Outlet | choice |
Sale ID | text |
Sale Date | date |
Invoice Number | text |
Short Code | text |
5other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Short Code | text |
Invoice Number | text |
Receipt Number | text |
Note | text |
Customer ID | text |
Sale Date | date |
12other output fields
Input fields
| Field | Type |
|---|---|
Stock AdjustmentsRequired | array |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Product ID | text |
Outlet ID | text |
User ID | text |
Quantity | text |
Reason | text |
Custom Reason ID | text |
Version | number |
2other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
AmountRequired | number |
Client ID | text |
Output fields
| Field | Type |
|---|---|
Transaction ID | text |
Type | text |
Amount | number |
Client ID | text |
Notes | text |
Sale ID | text |
User ID | text |
Created At | date |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Transaction TypeRequired | choice |
AmountRequired | number |
Client IDRequired | text |
Notes | text |
User | choice |
Output fields
| Field | Type |
|---|---|
Transaction ID | text |
Type | text |
Amount | number |
Client ID | text |
Notes | text |
Sale ID | text |
User ID | text |
Created At | date |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Contact | object |
Company Name | text |
Email | text |
Fax | text |
First Name | text |
Last Name | text |
Mobile | text |
Phone | text |
Physical Address 1 | text |
Physical Address 2 | text |
Physical City | text |
Description | text |
Default Markup | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Output fields
| Field | Type |
|---|---|
Tag ID | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
RateRequired | number |
Tax Over Threshold | boolean |
Clothing/Footwear Exemption | boolean |
Clothing/Footwear Threshold Value | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Display Name | text |
Is Default | boolean |
Rates | array |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Event TypeRequired | choice |
URLRequired | text |
ActiveRequired | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Retailer ID | text |
Active | boolean |
Type | text |
URL | text |
Input fields
| Field | Type |
|---|---|
BrandRequired | choice |
Output fields
| Field | Type |
|---|---|
Deleted Brand ID | text |
Disassociation Job ID | text |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Address IDRequired | number |
Input fields
| Field | Type |
|---|---|
Custom Field IDRequired | text |
Output fields
| Field | Type |
|---|---|
Deleted Custom Field ID | text |
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
Price Book Product IDsRequired | array |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Input fields
| Field | Type |
|---|---|
Category IDsRequired | array |
Output fields
| Field | Type |
|---|---|
Deleted Categories | array |
Input fields
| Field | Type |
|---|---|
Product (in the family)Required | choice |
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | text |
Input fields
| Field | Type |
|---|---|
SupplierRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Job ID | text |
Input fields
| Field | Type |
|---|---|
TagRequired | choice |
Output fields
| Field | Type |
|---|---|
Deleted Tag ID | text |
Disassociation Job ID | text |
Input fields
| Field | Type |
|---|---|
Variant AttributeRequired | choice |
Input fields
| Field | Type |
|---|---|
WebhookRequired | choice |
Output fields
| Field | Type |
|---|---|
Deleted Webhook ID | text |
Input fields
| Field | Type |
|---|---|
Fulfillment IDRequired | text |
Fulfillment VersionRequired | number |
Line ItemsRequired | array |
Output fields
| Field | Type |
|---|---|
Fulfillment ID | text |
Version | number |
Input fields
| Field | Type |
|---|---|
SaleRequired | choice |
Output fields
| Field | Type |
|---|---|
Fulfillment ID | text |
Version | number |
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 |
|---|---|
RegisterRequired | choice |
Register Open Time | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Outlet ID | text |
Is Open | boolean |
Register Open Time | date |
Register Close Time | date |
Invoice Prefix | text |
Invoice Suffix | text |
13other output fields
Input fields
| Field | Type |
|---|---|
Fulfillment IDRequired | text |
Fulfillment VersionRequired | number |
Line ItemsRequired | array |
Output fields
| Field | Type |
|---|---|
Fulfillment ID | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Fulfillment IDRequired | text |
Fulfillment VersionRequired | number |
Line ItemsRequired | array |
Output fields
| Field | Type |
|---|---|
Fulfillment ID | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
ProductRequired | choice |
Input fields
| Field | Type |
|---|---|
Customer GroupRequired | choice |
Customers | choice |
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
ProductsRequired | array |
Output fields
| Field | Type |
|---|---|
Price Book Products | array |
Input fields
| Field | Type |
|---|---|
Sale to ReturnRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Created At | date |
Updated At | date |
Customer ID | text |
Invoice Number | text |
Invoice Sequence | number |
Receipt Number | text |
Receipt Sequence | number |
16other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Reference IDRequired | text |
Input fields
| Field | Type |
|---|---|
Entity TypeRequired | choice |
Entity IDRequired | text |
ValuesRequired | array |
Output fields
| Field | Type |
|---|---|
Custom Field Definition ID | text |
Name | text |
Title | text |
Value Type | text |
String Value | text |
Integer Value | number |
Boolean Value | boolean |
Input fields
| Field | Type |
|---|---|
Product Image IDRequired | text |
New PositionRequired | number |
Output fields
| Field | Type |
|---|---|
Image ID | text |
Product ID | text |
Position | number |
Status | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Reorder PointsRequired | array |
Limit | number |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Outlet ID | text |
Method | text |
Reorder Point | number |
Reorder Amount | number |
Reorder Target | number |
Input fields
| Field | Type |
|---|---|
BrandRequired | choice |
Name | text |
Description | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
NameRequired | text |
OutletRequired | choice |
TypeRequired | choice |
Status | choice |
Supplier | choice |
Source Outlet | choice |
Supplier Invoice | text |
1other input field
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Status | text |
Outlet ID | text |
Source Outlet ID | text |
Supplier ID | text |
Supplier Invoice | text |
12other output fields
Input fields
| Field | Type |
|---|---|
Consignment IDRequired | text |
ProductRequired | choice |
Expected Count | text |
Received Count | text |
Cost | text |
Output fields
| Field | Type |
|---|---|
Product ID | text |
Product SKU | text |
Expected Count | text |
Received Count | text |
Cost | text |
Status | text |
Is Included | boolean |
Created At | date |
3other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Company Name | text |
Customer Code | text |
Customer Group | choice |
Email | |
Phone | text |
30other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
First Name | text |
Last Name | text |
Company Name | text |
Customer Code | text |
Customer Group ID | text |
Email | text |
38other output fields
Input fields
| Field | Type |
|---|---|
CustomerRequired | choice |
Address IDRequired | number |
Address Line 1Required | text |
CityRequired | text |
PostcodeRequired | text |
Country CodeRequired | text |
TypeRequired | choice |
Address Line 2 | text |
3other input fields
Output fields
| Field | Type |
|---|---|
ID | number |
Customer ID | text |
Type | text |
Address Line 1 | text |
Address Line 2 | text |
City | text |
Suburb | text |
State | text |
6other output fields
Input fields
| Field | Type |
|---|---|
Customer GroupRequired | choice |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Group ID | text |
Retailer ID | text |
Created At | date |
Updated At | date |
Deleted At | date |
Version | number |
Input fields
| Field | Type |
|---|---|
Custom Field IDRequired | text |
Title | text |
Editable In UI | boolean |
Visible In UI | boolean |
Print On Receipt | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Title | text |
Entity Type | text |
Value Type | text |
Editable In UI | boolean |
Visible In UI | boolean |
Created At | date |
Input fields
| Field | Type |
|---|---|
Custom Reason IDRequired | text |
Name | text |
Enabled | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Enabled | boolean |
Type | text |
Created Via API | boolean |
Version | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
Name | text |
Customer Group IDs | array |
Outlets | choice |
Restrict To Platform | choice |
Valid From | date |
Valid To | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Version | number |
Input fields
| Field | Type |
|---|---|
Price BookRequired | choice |
ProductsRequired | array |
Output fields
| Field | Type |
|---|---|
Price Book Products | array |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Name | text |
SKU | text |
Description | text |
Brand | choice |
Supplier | choice |
Supplier Code | text |
Supply Price | number |
9other input fields
Output fields
| Field | Type |
|---|---|
Type | text |
Input fields
| Field | Type |
|---|---|
Sale to UpdateRequired | choice |
StateRequired | choice |
SourceRequired | object |
Author (Cashier)Required | choice |
Register | choice |
External Source ID | text |
External System Type | text |
Customer | choice |
Fulfillment Outlet | choice |
Sale Date | date |
Invoice Number | text |
Short Code | text |
5other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
State | text |
Short Code | text |
Invoice Number | text |
Receipt Number | text |
Note | text |
Customer ID | text |
Sale Date | date |
12other output fields
Input fields
| Field | Type |
|---|---|
SupplierRequired | choice |
NameRequired | text |
Contact | object |
Company Name | text |
Email | text |
Fax | text |
First Name | text |
Last Name | text |
Mobile | text |
Phone | text |
Physical Address 1 | text |
Physical Address 2 | text |
Physical City | text |
Description | text |
Default Markup | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
TagRequired | choice |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Input fields
| Field | Type |
|---|---|
Variant AttributeRequired | choice |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
WebhookRequired | choice |
Event TypeRequired | choice |
URLRequired | text |
ActiveRequired | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Retailer ID | text |
Active | boolean |
Type | text |
URL | text |
Input fields
| Field | Type |
|---|---|
ProductRequired | choice |
Image FileRequired | text |
Output fields
| Field | Type |
|---|---|
Image ID | text |
Product ID | text |
Position | number |
Status | text |
Version | number |