Square

Square module for RobinPath.

Package: @robinpath/square | Category: Ecommerce | Type: Integration

Authentication

square.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the square module when you need to:

• listCatalogItems -- Use square.listCatalogItems to perform this operation
• getCatalogItem -- Use square.getCatalogItem to perform this operation
• upsertCatalogObject -- Use square.upsertCatalogObject to perform this operation
• deleteCatalogObject -- Use square.deleteCatalogObject to perform this operation
• searchCatalog -- Use square.searchCatalog to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure square credentials.	object
listCatalogItems	listCatalogItems	object
getCatalogItem	getCatalogItem	object
upsertCatalogObject	upsertCatalogObject	object
deleteCatalogObject	deleteCatalogObject	object
searchCatalog	searchCatalog	object
listCustomers	listCustomers	object
getCustomer	getCustomer	object
createCustomer	createCustomer	object
updateCustomer	updateCustomer	object
deleteCustomer	deleteCustomer	object
listOrders	listOrders	object
getOrder	getOrder	object
createOrder	createOrder	object
listLocations	listLocations	object
getLocation	getLocation	object
listInventory	listInventory	object
adjustInventory	adjustInventory	object
retrieveInventoryCount	retrieveInventoryCount	object
getMerchant	getMerchant	object
listPayments	listPayments	object

Functions

setCredentials

Configure square credentials.

Module: square | Returns: object -- API response.

square.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listCatalogItems

listCatalogItems

Module: square | Returns: object -- API response.

square.listCatalogItems

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getCatalogItem

getCatalogItem

Module: square | Returns: object -- API response.

square.getCatalogItem

Parameter	Type	Required	Description
input	string	No	Input parameter

---

upsertCatalogObject

upsertCatalogObject

Module: square | Returns: object -- API response.

square.upsertCatalogObject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteCatalogObject

deleteCatalogObject

Module: square | Returns: object -- API response.

square.deleteCatalogObject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchCatalog

searchCatalog

Module: square | Returns: object -- API response.

square.searchCatalog

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCustomers

listCustomers

Module: square | Returns: object -- API response.

square.listCustomers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getCustomer

getCustomer

Module: square | Returns: object -- API response.

square.getCustomer

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createCustomer

createCustomer

Module: square | Returns: object -- API response.

square.createCustomer

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateCustomer

updateCustomer

Module: square | Returns: object -- API response.

square.updateCustomer

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteCustomer

deleteCustomer

Module: square | Returns: object -- API response.

square.deleteCustomer

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listOrders

listOrders

Module: square | Returns: object -- API response.

square.listOrders

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getOrder

getOrder

Module: square | Returns: object -- API response.

square.getOrder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createOrder

createOrder

Module: square | Returns: object -- API response.

square.createOrder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listLocations

listLocations

Module: square | Returns: object -- API response.

square.listLocations

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getLocation

getLocation

Module: square | Returns: object -- API response.

square.getLocation

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listInventory

listInventory

Module: square | Returns: object -- API response.

square.listInventory

Parameter	Type	Required	Description
input	string	No	Input parameter

---

adjustInventory

adjustInventory

Module: square | Returns: object -- API response.

square.adjustInventory

Parameter	Type	Required	Description
input	string	No	Input parameter

---

retrieveInventoryCount

retrieveInventoryCount

Module: square | Returns: object -- API response.

square.retrieveInventoryCount

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMerchant

getMerchant

Module: square | Returns: object -- API response.

square.getMerchant

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPayments

listPayments

Module: square | Returns: object -- API response.

square.listPayments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Square API error (${res.status}): ${t}	Check the error message for details
square.setCredentials requires accessToken.	Check the error message for details
square.deleteCatalogObject requires an ID.	Check the error message for details
square.updateCustomer requires an ID.	Check the error message for details
square.deleteCustomer requires an ID.	Check the error message for details
square.adjustInventory requires an ID.	Check the error message for details
Square: "..." not configured. Call square.setCredentials first.	Check the error message for details

@desc "List catalog items and validate result"
do
  set $result as square.listCatalogItems
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate CatalogItems

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "List catalog items and iterate results"
do
  set $result as square.listCatalogItems
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createCustomer

Create a new resource and capture the result.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "Create customer"
do
  set $result as square.createCustomer
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "Create customer and update customer"
do
  set $created as square.createCustomer
  # Update the created item
  square.updateCustomer
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "List catalog items and create customer"
do
  set $existing as square.listCatalogItems
  if $existing == null
    square.createCustomer
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Square workflow

Chain multiple square operations together.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "List catalog items, get catalog item, and more"
do
  set $r_listCatalogItems as square.listCatalogItems
  set $r_getCatalogItem as square.getCatalogItem
  set $r_upsertCatalogObject as square.upsertCatalogObject
  print "All operations complete"
enddo

6. Safe listCatalogItems with validation

Check results before proceeding.

@desc "Setup authentication"
do
  square.setCredentials $token
enddo

@desc "List catalog items and validate result"
do
  set $result as square.listCatalogItems
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• shopify -- Shopify module for complementary functionality
• woocommerce -- WooCommerce module for complementary functionality
• bigcommerce -- BigCommerce module for complementary functionality
• json -- JSON module for complementary functionality