Square
App · E-Commerce · 7 actions
Manage Square customers, catalog items, orders, and payment links.
Actions
| Action | What it does |
|---|---|
| Create customer | Create a Square customer profile. |
| Create payment link | Create a Square-hosted payment link to charge a single custom amount. |
| List catalog items | List Square catalog items. |
| List locations | List Square business locations. |
| Retrieve order | Retrieve a Square order by ID. |
| Search customers | Search your Square customers. |
| Search orders | Search Square orders. |
Create customer
Create a Square customer profile.
Inputs
- First name
given_nametextRequired - Customer first name.
- Last name
family_nametext - Customer last name.
- Email address
email_addresstext - Customer email address.
- Phone number
phone_numbertext - Customer phone number.
Outputs
customerobject- Created customer record.
Example output
{
"customer": {
"family_name": "Doe",
"given_name": "Jane",
"id": "cust_123"
}
}Create payment link
Create a Square-hosted payment link to charge a single custom amount.
Inputs
- Location ID
location_idtextRequired - Square location ID to associate with the checkout.
- Amount
amountnumberRequired - Amount to charge, in the smallest currency unit (e.g. cents for USD).At least 1.
- Currency
currencytextRequired - ISO 4217 currency code, such as USD.
Outputs
payment_linkobject- Created payment link.
Example output
{
"payment_link": {
"id": "plink_123",
"order_id": "order_123",
"url": "https://square.link/u/example"
}
}List catalog items
List Square catalog items.
Inputs
- Item types
typeslist - The kinds of catalog objects to include, such as ITEM, CATEGORY, or DISCOUNT. Defaults to ITEM.
Outputs
itemslist- Catalog items.
Example output
{
"items": [
{
"id": "item_123",
"name": "Coffee",
"type": "ITEM"
}
]
}List locations
List Square business locations.
Inputs
None.
Outputs
locationslist- Square locations.
Example output
{
"locations": [
{
"id": "location_123",
"name": "Downtown Store",
"status": "ACTIVE"
}
]
}Retrieve order
Retrieve a Square order by ID.
Inputs
- Order ID
order_idtextRequired - Square order ID.
Outputs
orderobject- Order details.
Example output
{
"order": {
"id": "order_123",
"state": "COMPLETED",
"total_money": {
"amount": 2500,
"currency": "USD"
}
}
}Search customers
Search your Square customers.
Inputs
- Search text
query_texttextRequired - Text to fuzzy-match against customer email addresses.
Outputs
customerslist- Customer records.
Example output
{
"customers": [
{
"family_name": "Doe",
"given_name": "Jane",
"id": "cust_123"
}
]
}Search orders
Search Square orders.
Inputs
- Location ID
location_idtextRequired - Square location ID to search for orders.
- States
stateslist - Optional order states to filter by, such as OPEN, COMPLETED, or CANCELED.
Outputs
orderslist- Order results.
Example output
{
"orders": [
{
"id": "order_123",
"state": "COMPLETED",
"total_money": {
"amount": 2500,
"currency": "USD"
}
}
]
}