Square APIs
Account Request URL
https://developer.squareup.com/docs/square-get-startedBase Endpoint
https://connect.squareup.com/v2
Accounts
Provides access to the authenticated account's information.
/v2/accounts
BankAccounts
Creates a bank account for a given merchant.
/v2/bank-accounts
BusinessProfiles
Retrieves a business's profile information.
/v2/business-profiles/[profile_id]
CatalogItem
Retrieves a single CatalogItem by `id`.
/v2/catalog/items/[item_id]
CatalogItem
Creates a CatalogItem for a given merchant.
/v2/catalog/items
catalog_object_id, name, description, abbreviation, prices, item_data, variations, product_type, taxable, available_online, available_for_pickup, skip_modifier_screen, available_electronically, available_in_person
CatalogItemVariation
Retrieves a single CatalogItemVariation by `id`.
/v2/catalog/item-variations/[item_variation_id]
CatalogModifierList
Retrieves a single CatalogModifierList by `id`.
/v2/catalog/modifier-lists/[modifier_list_id]
CatalogModifier
Retrieves a single CatalogModifier by `id`.
/v2/catalog/modifiers/[modifier_id]
CatalogCategory
Retrieves a single CatalogCategory by `id`.
/v2/catalog/categories/[category_id]
CatalogDiscount
Retrieves a single CatalogDiscount by `id`.
/v2/catalog/discounts/[discount_id]
Customers
Retrieves a customer using the given `customer_id`.
/v2/customers/[customer_id]
Customers
Creates a new `Customer` object. Call this method to add a new customer profile. When a customer is created
a customer profile is created with the data provided
and the `customer_id` is returned.
Customers
Updates a customer profile.
/v2/customers/[customer_id]
given_name, family_name, email_address, address, phone_number, reference_id, note, company_name, birthday
Customers
Deletes a customer profile.
/v2/customers/[customer_id]
CustomerGroups
Retrieves a customer group using the given `customer_group_id`.
/v2/customer-groups/[customer_group_id]
CustomerGroups
Creates a customer group.
/v2/customer-groups
name
CustomerGroups
Updates the name of the customer group.
/v2/customer-groups/[customer_group_id]
name
CustomerGroups
Deletes a customer group.
/v2/customer-groups/[customer_group_id]
GiftCards
Retrieves a gift card by `id`.
/v2/gift-cards/[gift_card_id]
GiftCards
Creates a gift card for a given merchant.
/v2/gift-cards
amount_money, currency
GiftCards
Updates the state of a gift card by `id`.
/v2/gift-cards/[gift_card_id]
state
GiftCards
Deletes a gift card by `id`.
/v2/gift-cards/[gift_card_id]
GiftCardsActivity
Retrieves a gift card activity by `id`.
/v2/gift-cards/[gift_card_id]/activities/[activity_id]
Invoices
Retrieves an invoice by `id`.
/v2/invoices/[invoice_id]
Invoices
Creates a invoice for a given merchant.
/v2/invoices
currency_code, invoice_items
Invoices
Updates an invoice by `id`.
/v2/invoices/[invoice_id]
invoice_items
Invoices
Deletes an invoice by `id`.
/v2/invoices/[invoice_id]
Items
Retrieves a single Item by `id`.
/v2/items/[item_id]
Items
Creates an Item for a given merchant.
/v2/items
name, description, type, category, modifier_lists, variations, tax_rates, available_online, available_for_pickup, available_electronically, available_in_person
Items
Updates an Item by `id`.
/v2/items/[item_id]
name, description, type, category, modifier_lists, variations, tax_rates, available_online, available_for_pickup, available_electronically, available_in_person
Items
Deletes an Item by `id`.
/v2/items/[item_id]
Locations
Retrieves a location by `id`.
/v2/locations/[location_id]
Locations
Creates a location for a given merchant.
/v2/locations
name, address, timezone, capabilities, business_hours, coordinates, phone_number, country, city, postal_code, state
Locations
Updates a location by `id`.
/v2/locations/[location_id]
name, address, timezone, capabilities, business_hours, coordinates, phone_number, country, city, postal_code, state
Locations
Deletes a location by `id`.
/v2/locations/[location_id]
LoyaltyAccounts
Retrieves a loyalty account object associated with the given `loyalty_account_id`. Customer Loyalty Accounts represent customer-specific program membership information for any program managed in Square Loyalty API.
/v2/loyalty-accounts/[loyalty_account_id]
LoyaltyAccounts
Creates a loyalty account and associates it with the given `customer_id`. Before you can create a loyalty account
you must set up a loyalty program in the Square Dashboard. Customer Loyalty Accounts represent customer-specific program membership information for any program managed in Square Loyalty API.
/v2/loyalty-accounts
LoyaltyAccounts
Updates the fields of a loyalty account.
/v2/loyalty-accounts/[loyalty_account_id]
loyalty_account, loyalty_account_data
LoyaltyEvents
Retrieves a loyalty event by `id`.
/v2/loyalty-events/[loyalty_event_id]
LoyaltyEvents
Creates a new loyalty event for a given `loyalty_account_id`.
/v2/loyalty-events
loyalty_account_id, type, happened_at, location_id, amount_money, source, data
LoyaltyRewards
Retrieves a loyalty reward by `id`.
/v2/loyalty-rewards/[loyalty_reward_id]
LoyaltyRewards
Creates a loyalty reward and associates it with the given `loyalty_program_id`. Before you can create a loyalty reward
you must set up a loyalty program in the Square Dashboard.
/v2/loyalty-rewards
LoyaltyRewards
Updates the fields of a loyalty reward.
/v2/loyalty-rewards/[loyalty_reward_id]
loyalty_reward, loyalty_reward_data
LoyaltyPrograms
Retrieves a loyalty program by `id`.
/v2/loyalty-programs/[loyalty_program_id]
LoyaltyPrograms
Creates a loyalty program for a given merchant.
/v2/loyalty-programs
name, description, external_id
LoyaltyPrograms
Updates a loyalty program.
/v2/loyalty-programs/[loyalty_program_id]
name, description, external_id
Merchant
Retrieves the merchant's Square account information.
/v2/merchants/[merchant_id]
Merchant
Adds a Merchant to an existing business or creates a new business if no business is specified.
/v2/merchants
language_code, currency_code, display_name, email_address, phone_number, website_url, company_name, business_type
MerchantCatalog
Retrieves a catalog object for a given merchant.
/v2/merchant-catalog/[catalog_id]
MerchantCatalog
Creates a new Catalog object for a given merchant.
/v2/merchant-catalog
name, description, is_public
MerchantCatalog
Updates the name and description of a catalog.
/v2/merchant-catalog/[catalog_id]
name, description
MerchantCatalog
Deletes a catalog by `id`. Note that deleting a catalog will also delete child objects
such as [CatalogItem](#type-catalogitem) objects.
/v2/merchant-catalog/[catalog_id]
MerchantCatalogItem
Retrieves a single CatalogItem by `id`.
/v2/merchant-catalog/[catalog_id]/items/[item_id]
MerchantCatalogItem
Creates a CatalogItem for a given merchant.
/v2/merchant-catalog/[catalog_id]/items
name, description, abbreviation, prices, item_data, variations, product_type, taxable, available_online, available_for_pickup, skip_modifier_screen, available_electronically, available_in_person
MerchantCatalogItem
Updates a CatalogItem for a
Details
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Other Apps
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.
