Streamdata.io API Gallery - Square (Report Issue)

Organization(s):

Square Get Location Bank Accounts

Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Square Get Location Bank Accounts Bank Account

Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Square Get Location Cash Drawer Shifts

Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.

Square Get Location Cash Drawer Shifts Shift

Provides the details for a single cash drawer shift, including all events that occurred during the shift.

Square Get Location Categories

Lists all of a location's item categories.

Square Post Location Categories

Creates an item category.

Square Delete Location Categories Category

Delete location categories category.

Square Put Location Categories Category

Modifies the details of an existing item category.

Square Get Location Discounts

Lists all of a location's discounts.

Square Post Location Discounts

Post location discounts.

Square Delete Location Discounts Discount

Delete location discounts discount.

Square Put Location Discounts Discount

Modifies the details of an existing discount.

Square Get Location Fees

Lists all of a location's fees (taxes).

Square Post Location Fees

Creates a fee (tax).

Square Delete Location Fees Fee

Deletes an existing fee (tax).

Square Put Location Fees Fee

Modifies the details of an existing fee (tax).

Square Get Location Inventory

Provides inventory information for all of a merchant's inventory-enabled item variations.

Square Post Location Inventory Variation

Adjusts an item variation's current available inventory.

Square Get Location Items

Provides summary information for all of a location's items.

Square Post Location Items

Creates an item and at least one variation for it.

Square Delete Location Items Item

Deletes an existing item and all item variations associated with it.

Square Get Location Items Item

Provides the details for a single item, including associated modifier lists and fees.

Square Put Location Items Item

Modifies the core details of an existing item.

Square Delete Location Items Item Fees Fee

Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.

Square Put Location Items Item Fees Fee

Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.

Square Delete Location Items Item Modifier Lists Modifier List

Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.

Square Put Location Items Item Modifier Lists Modifier List

Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.

Square Post Location Items Item Variations

Creates an item variation for an existing item.

Square Delete Location Items Item Variations Variation

Deletes an existing item variation from an item.

Square Put Location Items Item Variations Variation

Modifies the details of an existing item variation.

Square Get Location Modifier Lists

Lists all of a location's modifier lists.

Square Post Location Modifier Lists

Creates an item modifier list and at least one modifier option for it.

Square Delete Location Modifier Lists Modifier List

Deletes an existing item modifier list and all modifier options associated with it.

Square Get Location Modifier Lists Modifier List

Provides the details for a single modifier list.

Square Put Location Modifier Lists Modifier List

Modifies the details of an existing item modifier list.

Square Post Location Modifier Lists Modifier List Modifier Options

Creates an item modifier option and adds it to a modifier list.

Square Delete Location Modifier Lists Modifier List Modifier Options Modifier Option

Delete location modifier lists modifier list modifier options modifier option.

Square Put Location Modifier Lists Modifier List Modifier Options Modifier Option

Put location modifier lists modifier list modifier options modifier option.

Square Get Location Orders

Provides summary information for a merchant's online store orders.

Square Get Location Orders Order

Provides comprehensive information for a single online store order, including the order's history.

Square Put Location Orders Order

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

Square Get Location Pages

Lists all of a location's Favorites pages in Square Register.

Square Post Location Pages

Creates a Favorites page in Square Register.

Square Delete Location Pages Page

Deletes an existing Favorites page and all of its cells.

Square Put Location Pages Page

Modifies the details of a Favorites page in Square Register.

Square Delete Location Pages Page Cells

Deletes a cell from a Favorites page in Square Register.

Square Put Location Pages Page Cells

Modifies a cell of a Favorites page in Square Register.

Square Get Location Payments

Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.

Square Get Location Payments Payment

Provides comprehensive information for a single payment.

Square Get Location Refunds

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Square Post Location Refunds

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.

Square Get Location Settlements

Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.

Square Get Location Settlements Settlement

Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.

Square Get Me

Get a business's information.

Square Get Me Employees

Provides summary information for all of a business's employees.

Square Post Me Employees

Creates an employee for a business.

Square Get Me Employees Employee

Provides the details for a single employee.

Square Put Me Employees Employee

Put me employees employee.

Square Get Me Locations

Provides details for a business's locations, including their IDs.

Square Get Me Roles

Provides summary information for all of a business's employee roles.

Square Post Me Roles

Creates an employee role you can then assign to employees.

Square Get Me Roles Role

Provides the details for a single employee role.

Square Put Me Roles Role

Modifies the details of an employee role.

Square Get Me Timecards

Provides summary information for all of a business's employee timecards.

Square Post Me Timecards

Creates a timecard for an employee. Each timecard corresponds to a single shift.

Square Delete Me Timecards

Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.

Square Get Me Timecards

Provides the details for a single timecard.

Square Put Me Timecards

Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.

Square Get Me Timecards Events

Provides summary information for all events associated with a particular timecard.

Square Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Square Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Square Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.

Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.

Square Provides the details for a single cash drawer shift, including all events that occurred during the shift.

Provides the details for a single cash drawer shift, including all events that occurred during the shift.

Square Lists all of a location's item categories.

Lists all of a location's item categories.

Square Creates an item category.

Creates an item category.

Square Deletes an existing item category.

Deletes an existing item category.

Square Modifies the details of an existing item category.

Modifies the details of an existing item category.

Square Lists all of a location's discounts.

Lists all of a location's discounts.

Square Creates a discount.

Creates a discount.

Square Deletes an existing discount.

Deletes an existing discount.

Square Modifies the details of an existing discount.

Modifies the details of an existing discount.

Square Lists all of a location's fees (taxes).

Lists all of a location's fees (taxes).

Square Creates a fee (tax).

Creates a fee (tax).

Square Deletes an existing fee (tax).

Deletes an existing fee (tax).

Square Modifies the details of an existing fee (tax).

Modifies the details of an existing fee (tax).

Square Provides inventory information for all of a merchant's inventory-enabled item variations.

Provides inventory information for all of a merchant's inventory-enabled item variations.

Square Adjusts an item variation's current available inventory.

Adjusts an item variation's current available inventory.

Square Provides summary information for all of a location's items.

Provides summary information for all of a location's items.

Square Creates an item and at least one variation for it.

Creates an item and at least one variation for it.

Square Deletes an existing item and all item variations associated with it.

Deletes an existing item and all item variations associated with it.

Square Provides the details for a single item, including associated modifier lists and fees.

Provides the details for a single item, including associated modifier lists and fees.

Square Modifies the core details of an existing item.

Modifies the core details of an existing item.

Square Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.

Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.

Square Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.

Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.

Square Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.

Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.

Square Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.

Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.

Square Creates an item variation for an existing item.

Creates an item variation for an existing item.

Square Deletes an existing item variation from an item.

Deletes an existing item variation from an item.

Square Modifies the details of an existing item variation.

Modifies the details of an existing item variation.

Square Lists all of a location's modifier lists.

Lists all of a location's modifier lists.

Square Creates an item modifier list and at least one modifier option for it.

Creates an item modifier list and at least one modifier option for it.

Square Deletes an existing item modifier list and all modifier options associated with it.

Deletes an existing item modifier list and all modifier options associated with it.

Square Provides the details for a single modifier list.

Provides the details for a single modifier list.

Square Modifies the details of an existing item modifier list.

Modifies the details of an existing item modifier list.

Square Creates an item modifier option and adds it to a modifier list.

Creates an item modifier option and adds it to a modifier list.

Square Deletes an existing item modifier option from a modifier list.

Deletes an existing item modifier option from a modifier list.

Square Modifies the details of an existing item modifier option.

Modifies the details of an existing item modifier option.

Square Provides summary information for a merchant's online store orders.

Provides summary information for a merchant's online store orders.

Square Provides comprehensive information for a single online store order, including the order's history.

Provides comprehensive information for a single online store order, including the order's history.

Square Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

Square Lists all of a location's Favorites pages in Square Register.

Lists all of a location's Favorites pages in Square Register.

Square Creates a Favorites page in Square Register.

Creates a Favorites page in Square Register.

Square Deletes an existing Favorites page and all of its cells.

Deletes an existing Favorites page and all of its cells.

Square Modifies the details of a Favorites page in Square Register.

Modifies the details of a Favorites page in Square Register.

Square Deletes a cell from a Favorites page in Square Register.

Deletes a cell from a Favorites page in Square Register.

Square Modifies a cell of a Favorites page in Square Register.

Modifies a cell of a Favorites page in Square Register.

Square Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.

Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates.

Square Provides comprehensive information for a single payment.

Provides comprehensive information for a single payment.

Square Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Square Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment.

Square Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.

Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length.

Square Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.

Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total.

Square Get a business's information.

Get a business's information.

Square Provides summary information for all of a business's employees.

Provides summary information for all of a business's employees.

Square Creates an employee for a business.

Creates an employee for a business.

Square Provides the details for a single employee.

Provides the details for a single employee.

Square Update Employee

Update Employee

Square Provides details for a business's locations, including their IDs.

Provides details for a business's locations, including their IDs.

Square Provides summary information for all of a business's employee roles.

Provides summary information for all of a business's employee roles.

Square Creates an employee role you can then assign to employees.

Creates an employee role you can then assign to employees.

Square Provides the details for a single employee role.

Provides the details for a single employee role.

Square Modifies the details of an employee role.

Modifies the details of an employee role.

Square Provides summary information for all of a business's employee timecards.

Provides summary information for all of a business's employee timecards.

Square Creates a timecard for an employee. Each timecard corresponds to a single shift.

Creates a timecard for an employee. Each timecard corresponds to a single shift.

Square Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.

Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.

Square Provides the details for a single timecard.

Provides the details for a single timecard.

Square Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.

Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.

Square Provides summary information for all events associated with a particular timecard.

Provides summary information for all events associated with a particular timecard.

Square Post V2 Apple Pay Domains

Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk ac...

Square BatchDeleteCatalogObjects

Deletes a set of [CatalogItem](#type-catalogitem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted...

Square BatchRetrieveCatalogObjects

Returns a set of objects based on the provided ID. Each [CatalogItem](#type-catalogitem) returned in the set includes all of its child information including: all of its [CatalogItemVariation](#type-catalogitemvariation) objects, references to its ...

Square BatchUpsertCatalogObjects

Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way,...

Square CatalogInfo

Returns information about the Square Catalog API, such as batch size limits for `BatchUpsertCatalogObjects`.

Square ListCatalog

Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter is speci...

Square UpsertCatalogObject

Creates or updates the target [CatalogObject](#type-catalogobject).

Square DeleteCatalogObject

Deletes a single [CatalogObject](#type-catalogobject) based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For examp...

Square RetrieveCatalogObject

Returns a single [CatalogItem](#type-catalogitem) as a [CatalogObject](#type-catalogobject) based on the provided ID. The returned object includes all of the relevant [CatalogItem](#type-catalogitem) information including: [CatalogItemVariation](#...

Square SearchCatalogObjects

Queries the targeted catalog using a variety of query types ([CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), ([CatalogQueryExact](#type-catalogqueryexact), ([CatalogQueryRange](#type-catalogqueryrange), ([CatalogQueryText](#type-...

Square UpdateItemModifierLists

Updates the [CatalogModifierList](#type-catalogmodifierlist) objects that apply to the targeted [CatalogItem](#type-catalogitem) without having to perform an upsert on the entire item.

Square UpdateItemTaxes

Updates the [CatalogTax](#type-catalogtax) objects that apply to the targeted [CatalogItem](#type-catalogitem) without having to perform an upsert on the entire item.

Square ListCustomers

Lists a business's customers.

Square CreateCustomer

Creates a new customer for a business, which can have associated cards on file. You must provide __at least one__ of the following values in your request to this endpoint: - `given_name` - `family_name` - `company_name` - `email_address` - `phon...

Square DeleteCustomer

Deletes a customer from a business, along with any linked cards on file.

Square RetrieveCustomer

Returns details for a single customer.

Square UpdateCustomer

Updates the details of an existing customer. The ID of the customer may change if the customer has been merged into another customer. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delet...

Square CreateCustomerCard

Adds a card on file to an existing customer. In the United States Square takes care of automatically updating any cards on file that might have expired since you first attached them to a customer.

Square DeleteCustomerCard

Removes a card on file from a customer.

Square ListLocations

Provides the details for all of a business's locations. Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `locati...

Square Get V2 Locations Location Additional Recipient Receivable Refunds

Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page]...

Square Get V2 Locations Location Additional Recipient Receivables

Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingr...

Square CreateCheckout

Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

Square Post V2 Locations Location Orders

Creates an [Order](#type-order) that can then be referenced as `order_id` in a request to the [Charge](#endpoint-charge) endpoint. Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase. To ...

Square Post V2 Locations Location Orders Batch Retrieve

Retrieves a set of [Order](#type-order)s by their IDs. If a given Order ID does not exist, the ID is ignored instead of generating an error.

Square ListRefunds

Lists refunds for one of a business's locations. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50

Square ListTransactions

Lists transactions for a particular location. Max results per [page](#paginatingresults): 50

Square Charge

Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `...

Square RetrieveTransaction

Retrieves details for a single transaction.

Square CaptureTransaction

Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Square CreateRefund

Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See (this article)[https://squareup.com/help/us/en/article/5060] for more information on refund behavior.

Square VoidTransaction

Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.