Square Action Automation For

Workflows Documentation

Action Name: Create Customer Group

1. Group Name

  • Input Required: Enter the name of the customer group you wish to create.

Action Name: Update Customer Group

1. Group ID

  • Input Required: Enter the ID of the customer group you wish to update.

NB: Get the Group ID by using the action Search Groups By Name.

2. Name

  • Input Required: Enter the new name for the customer group.

Action Name: Delete Customer Group

1. Group ID

  • Input Required: Enter the ID of the customer group you wish to delete.

NB: Get the Group ID by using the action Search Groups By Name.

Action Name: Search Groups By Name

1. Groups Name

  • Input Required: Enter the name of the group you wish to search for.

Action Name: Create Customer

1. Given Name

  • Input Required: Enter the given name of the customer.

2. Family Name

  • Input Required: Enter the family name of the customer.

3. Company Name

  • Input Required: Enter the name of the company.

4. Email

  • Input Required: Enter the email address of the customer.

5. Phone Number

  • Input Required: Enter the phone number of the customer.

6. Note

  • Input Optional: Enter any additional notes about the customer.

Action Name: Update Customer

1. Customer ID

  • Input Required: Enter the ID of the customer you wish to update.

NB: Get the Customer ID by using the action Search Customers By Email.

2. Given Name

  • Input Required: Enter the given name of the customer.

3. Family Name

  • Input Required: Enter the family name of the customer.

4. Company Name

  • Input Required: Enter the name of the company.

5. Email

  • Input Required: Enter the email address of the customer.

6. Phone Number

  • Input Required: Enter the phone number of the customer.

7. Note

  • Input Optional: Enter any additional notes about the customer.

Action Name: Delete Customer

1. Customer ID

  • Input Required: Enter the ID of the customer you wish to delete.

NB: Get the Group ID by using the action Search Customers By Email.

Action Name: Search Customers by Email

1. Customer Email

  • Input Required: Enter the email address of the customer you wish to search for.

Action Name: Create Order

1. Location ID

  • Input Required: Enter the ID of the customer associated with the order.

NB: Get the Location ID by using the action Search Location By Name.

2. Customer ID

  • Input Required: Enter the ID of the customer associated with the order.

NB: Get the Customer ID by using the action Search Customers By Email.

3. Ticket Name

  • Input Required: Enter a short-term identifier for the order.

4. Source Name

  • Input Required: Enter the name used to identify where the order originates.

5. State

  • Input Required: Enter the current state of the order.

6. Discount Amount Money Currency

  • Input Required: Enter the type of currency, in ISO 4217 format.

7. Discounts Amount Money Amount

  • Input Required: Enter the amount of money, in the smallest denomination of the currency indicated by the currency.

8. Discount Scope

  • Input Required: Indicate the level at which the discount applies.

9. Calculation Phase

  • Input Required: Enter relevant details for the calculation phase.

10. Service Charges Amount Money Amount

  • Input Required: Enter the amount of money, in the smallest denomination of the currency indicated by the currency.

11. Service Charge Scope

  • Input Required: Specify the scope of the service charge.

12. Service Charges Amount Money Currency

  • Input Required: Enter the type of currency, in ISO 4217 format.

13. Service Charges Name

  • Input Required: Enter the name of the service charge.

Action Name: Update Order

1. Order ID

  • Input Required: Enter the ID of the order you wish to update.

NB: Get the Order ID by using the action Search Order By Ticket Name.

2. Location ID

  • Input Required: Enter the ID of the location associated with the order.

NB: Get the Location ID by using the action Search Location By Name.

3. Customer ID

  • Input Required: Enter the ID of the customer associated with the order.

NB: Get the Customer ID by using the action Search Customers By Email.

4. Ticket Name

  • Input Required: Enter a short-term identifier for the order.

5. State

  • Input Required: Enter the current state of the order.

6. Source Name

  • Input Required: Enter the name used to identify where the order originates.

7. Service Charges Amount Money Currency

  • Input Required: Enter the type of currency, in ISO 4217 format.

8. Service Charge Applied Taxes Tax UID

  • Input Required: Enter the UID of the tax for which this applied tax represents.

9. Service Charge Applied Taxes UID

  • Input Required: Enter a unique ID that identifies the applied tax only within this order.

10. Calculation Phase

  • Input Required: Enter relevant details for the calculation phase.

11. Service Charge Name

  • Input Required: Enter the name of the service charge.

12. Service Charge Percentage

  • Input Required: Enter the service charge percentage as a string representation of a decimal number.

13. Service Charge Scope

  • Input Required: Specify the scope of the service charge.

14. Service Charge Taxable

  • Input Required: Toggle on for true and off for false.

15. Service Charge UID

  • Input Required: Enter a unique ID that identifies the service charge only within this order.

16. Products Auto Apply Discount?

  • Input Required: Toggle on for true and off for false.

17. Product Auto Apply Taxes

  • Input Required: Toggle on for true and off for false.

18. Reference ID

  • Input Required: Enter a client-specified ID to associate an entity in another system with this order.

19. Discount Name

  • Input Required: Enter the name of the discount.

20. Discount Percentage

  • Input Required: Enter the discount percentage.

21. Discount Type

  • Input Required: Specify the type of discount.

22. Discount UID

  • Input Required: Enter the unique ID of the discount.

23. Discount Scope

  • Input Required: Specify the scope of the discount.

24. Discount Amount Money Currency

  • Input Required: Enter the type of currency, in ISO 4217 format.

25. Version

  • Input Required: Enter the version number.

26. Discounts Amount Money Amount

  • Input Required: Enter the amount of money, in the smallest denomination of the currency indicated by the currency.

27. Service Charges Amount Money Amount

  • Input Required: Enter the amount of money, in the smallest denomination of the currency indicated by the currency.

Action Name: Search Location By Name

1. Location Name

  • Input Required: Enter the name of the location you wish to find.

Action Name: Search Order By Ticket Name

1. Location ID

  • Input Required: Enter the reference number of the location associated with this order.

NB: Get the Location ID by using the action Search Location By Name.

2. Ticket Name

  • Input Required: Provide the name of the ticket you wish to find.