SquareupApi

Arcade Starter

Description: Tools that enable LLMs to interact directly with the squareup API.

Author: Arcade

Auth: User authorization

SquareupApi is a Starter MCP Server: each tool mirrors one HTTP endpoint and offers LLMs a way to interact with the low-level API.

Differently from Optimized MCP Servers, Starter tools are heavily influenced by the original API design, which is not usually optimized for LLM usage. For this reason, we recommend thoroughly evaluating the tools with your Agents or chatbots before using it in production. Read more about Optimized vs Starter tools.

The SquareupApi Server offers a comprehensive suite of for managing various aspects of the Square platform. can perform actions related to payments, customer management, inventory, and more. Key functionalities include:

Available Tools

Tool Name	Description
SquareupApi.RevokeOauthAccessToken	Revoke all OAuth access tokens for an account.
SquareupApi.ObtainOauthToken	Obtain OAuth access and refresh tokens.
SquareupApi.RetrieveTokenStatus	Retrieve the status of an OAuth or personal access token.
SquareupApi.ActivateDomainForApplePay	Activates a domain for use with Apple Pay and Square.
SquareupApi.ListBankAccounts	Fetches bank accounts linked to a Square account.
SquareupApi.GetBankAccountDetailsByV1Id	Fetches bank account details using a V1 ID.
SquareupApi.GetBankAccountDetails	Retrieve details of a bank account linked to a Square account.
SquareupApi.RetrieveBookings	Retrieve a collection of bookings.
SquareupApi.CreateBooking	Create a new booking for a service.
SquareupApi.SearchBookingAvailability	Find available booking slots for appointments.
SquareupApi.BulkRetrieveBookings	Retrieve multiple bookings using booking IDs.
SquareupApi.RetrieveBookingProfile	Retrieve a seller's booking profile information.
SquareupApi.ListBookingCustomAttributeDefinitions	Retrieve all custom attribute definitions for bookings.
SquareupApi.CreateBookingCustomAttribute	Creates a custom attribute definition for bookings.
SquareupApi.DeleteBookingCustomAttributeDefinition	Deletes a booking's custom attribute definition.
SquareupApi.RetrieveBookingCustomAttributeDefinition	Retrieve a booking's custom attribute definition.
SquareupApi.UpdateBookingCustomAttribute	Update a booking's custom attribute definition.
SquareupApi.BulkDeleteBookingCustomAttributes	Bulk delete custom attributes for bookings.
SquareupApi.BulkUpsertBookingCustomAttributes	Bulk upserts custom attributes for bookings.
SquareupApi.ListSellerBookingProfiles	Retrieve booking profiles for seller locations.
SquareupApi.RetrieveSellerLocationBookingProfile	Retrieve a seller's location booking profile.
SquareupApi.ListBookingProfiles	Retrieve booking profiles for team members.
SquareupApi.RetrieveTeamBookingProfiles	Retrieve booking profiles for one or more team members.
SquareupApi.GetTeamMemberBookingProfile	Retrieve a team member's booking profile from Square.
SquareupApi.RetrieveBooking	Retrieve detailed information about a booking.
SquareupApi.UpdateBooking	Update an existing booking with new details.
SquareupApi.CancelBooking	Cancel an existing booking.
SquareupApi.ListBookingCustomAttributes	Retrieve a booking's custom attributes.
SquareupApi.DeleteBookingCustomAttribute	Deletes a custom attribute from a booking.
SquareupApi.RetrieveBookingCustomAttribute	Retrieve custom attributes of a booking.
SquareupApi.SetBookingCustomAttribute	Upserts a custom attribute for a booking.
SquareupApi.ListUserCards	Retrieve a list of cards owned by the account.
SquareupApi.AddCardToMerchant	Adds a card on file to an existing merchant.
SquareupApi.RetrieveCardDetails	Retrieve details for a specific card.
SquareupApi.DisableCreditCard	Disable a credit card to prevent further charges.
SquareupApi.ListCashDrawerShifts	Retrieve cash drawer shift details for a location and date range.
SquareupApi.RetrieveCashDrawerShiftSummary	Retrieve summary details for a specific cash drawer shift.
SquareupApi.ListCashDrawerShiftEvents	Retrieve events for a specific cash drawer shift.
SquareupApi.DeleteCatalogItems	Deletes catalog items and their children by IDs.
SquareupApi.RetrieveCatalogObjects	Retrieve detailed catalog objects by provided IDs.
SquareupApi.BatchUpsertCatalogObjects	Batch create or update up to 10,000 catalog objects.
SquareupApi.GetSquareCatalogInfo	Retrieve Square Catalog API information and batch size limits.
SquareupApi.ListCatalogItems	Retrieve a list of catalog objects by type from Square catalog.
SquareupApi.UpsertCatalogObject	Create or update a catalog object in Squareup.
SquareupApi.DeleteCatalogObject	Delete a catalog object and its children by ID.
SquareupApi.GetCatalogItemInfo	Retrieve detailed information for a specific catalog item.
SquareupApi.SearchCatalogObjects	Search for catalog objects using specified query filters.
SquareupApi.SearchCatalogItems	Find catalog items or variations based on search filters.
SquareupApi.UpdateItemModifierLists	Update modifier lists for a catalog item.
SquareupApi.UpdateItemTaxes	Update tax settings for specified catalog items.
SquareupApi.ListSalesChannels	Retrieve a list of available sales channels.
SquareupApi.RetrieveSalesChannels	Retrieve bulk information about sales channels.
SquareupApi.RetrieveChannelInfo	Retrieve detailed information about a specific channel.
SquareupApi.ListCustomerProfiles	Retrieve customer profiles from a Square account.
SquareupApi.CreateCustomer	Creates a new customer for a business in Square.
SquareupApi.BulkCreateCustomers	Create multiple customer profiles in bulk.
SquareupApi.BulkDeleteCustomers	Deletes multiple customer profiles at once.
SquareupApi.BulkRetrieveCustomers	Retrieve multiple customer profiles using IDs.
SquareupApi.UpdateMultipleCustomerProfiles	Update multiple customer profiles in one request.
SquareupApi.ListCustomerCustomAttributeDefinitions	Retrieve customer custom attribute definitions for a Square seller.
SquareupApi.CreateCustomerAttributeDefinition	Create a custom attribute for customer profiles.
SquareupApi.DeleteCustomerAttributeDefinition	Delete a customer custom attribute definition from Square.
SquareupApi.GetCustomerCustomAttributeDefinition	Retrieve a customer's custom attribute definition from Square.
SquareupApi.UpdateCustomerAttributeDefinition	Update customer custom attribute definitions for a Square seller.
SquareupApi.BulkUpsertCustomerAttributes	Bulk create or update custom attributes for customer profiles.
SquareupApi.ListCustomerGroups	Retrieve a list of customer groups for a business.
SquareupApi.CreateCustomerGroup	Creates a new customer group for a business.
SquareupApi.DeleteCustomerGroup	Deletes a customer group by its ID.
SquareupApi.GetCustomerGroup	Retrieve details of a specific customer group by group ID.
SquareupApi.UpdateCustomerGroup	Updates a customer group by its ID.
SquareupApi.SearchSquareCustomers	Search customer profiles in a Square account.
SquareupApi.ListCustomerSegments	Retrieve customer segments for a business.
SquareupApi.GetCustomerSegment	Retrieve specific customer segment information.
SquareupApi.DeleteCustomerProfile	Delete a customer profile from a business system.
SquareupApi.RetrieveCustomerDetails	Retrieve detailed information for a specific customer.
SquareupApi.UpdateCustomerProfile	Update a customer's profile with new or changed details.
SquareupApi.ListCustomerCustomAttributes	Retrieve custom attributes of a customer profile.
SquareupApi.DeleteCustomerCustomAttribute	Deletes a custom attribute from a customer profile.
SquareupApi.GetCustomerCustomAttribute	Retrieve a custom attribute from a customer profile.
SquareupApi.UpdateCustomerCustomAttribute	Create or update a custom attribute for a customer profile.
SquareupApi.RemoveCustomerGroup	Remove a group membership from a customer.
SquareupApi.AddGroupToCustomer	Adds a customer to a specified group.
SquareupApi.ListMerchantDevices	Retrieve a list of devices for a merchant's terminal API.
SquareupApi.ListDeviceCodes	List all device codes for a merchant.
SquareupApi.CreateSquareTerminalDeviceCode	Generate a DeviceCode for Square Terminal login.
SquareupApi.RetrieveDeviceCode	Retrieve device code details by ID.
SquareupApi.RetrieveDeviceById	Retrieve specific device information using its ID.
SquareupApi.GetAccountDisputes	Retrieve a list of disputes for an account.
SquareupApi.RetrieveDisputeDetails	Retrieve details about a specific dispute using its ID.
SquareupApi.AcceptDisputeLoss	Accept the loss on a dispute and update its status to ACCEPTED.
SquareupApi.GetDisputeEvidence	Retrieve evidence for a specific dispute.
SquareupApi.UploadDisputeEvidenceText	Upload text evidence for a dispute challenge.
SquareupApi.RemoveDisputeEvidence	Removes specified evidence from a dispute in Square.
SquareupApi.GetDisputeEvidenceMetadata	Get metadata for specified dispute evidence.
SquareupApi.SubmitEvidenceToBank	Submit evidence for a dispute to the cardholder's bank.
SquareupApi.SearchSquareEvents	Search for Square API events within a specified timeframe.
SquareupApi.DisableSearchableEvents	Disable events to prevent them from being searchable.
SquareupApi.EnableEventsSearch	Enable events to make them searchable.
SquareupApi.ListEventTypes	Retrieve available event types for webhooks and API queries.
SquareupApi.ListGiftCards	Retrieve and filter a list of gift cards.
SquareupApi.CreateGiftCard	Create and register digital or physical gift cards.
SquareupApi.ListGiftCardActivities	Retrieve and filter gift card activities.
SquareupApi.CreateGiftCardActivity	Creates a gift card activity to manage gift card balance or state.
SquareupApi.RetrieveGiftCard	Retrieve a gift card using its account number.
SquareupApi.RetrieveGiftCardFromToken	Retrieve a gift card using a secure token.
SquareupApi.LinkCustomerToGiftCard	Link a customer to a gift card for future use.
SquareupApi.UnlinkCustomerFromGiftCard	Unlink a customer from a gift card.
SquareupApi.RetrieveGiftCardSquareup	Retrieve gift card details using a gift card ID.
SquareupApi.RetrieveInventoryAdjustment	Fetches inventory adjustment details by ID.
SquareupApi.ApplyInventoryAdjustments	Apply batch adjustments to inventory quantities.
SquareupApi.FetchInventoryChanges	Retrieve historical inventory changes and adjustments.
SquareupApi.RetrieveInventoryCounts	Retrieve current inventory counts for specific items and locations.
SquareupApi.GetInventoryPhysicalCount	Retrieve details of a specific inventory physical count.
SquareupApi.RetrieveInventoryTransfer	Retrieve detailed inventory transfer information.
SquareupApi.GetInventoryCount	Retrieve current stock count for a specific catalog item.
SquareupApi.ListInvoices	Retrieve a list of invoices for a specified location.
SquareupApi.CreateDraftInvoice	Create a draft invoice for an order using Squareup.
SquareupApi.SearchInvoices	Search for invoices based on location and optional customer.
SquareupApi.DeleteInvoice	Delete a draft invoice and change order status to CANCELED.
SquareupApi.RetrieveInvoiceById	Retrieve invoice details using an invoice ID.
SquareupApi.UpdateInvoice	Updates invoice details with specified changes.
SquareupApi.RemoveInvoiceAttachment	Removes an attachment from an invoice.
SquareupApi.CancelInvoice	Cancel an invoice to prevent further transactions.
SquareupApi.PublishInvoice	Publish a draft invoice with Square, updating its status.
SquareupApi.ListBreakTypes	Retrieve a paginated list of break types for a business.
SquareupApi.CreateBreakType	Create a new BreakType template for a location.
SquareupApi.DeleteBreakType	Deletes an existing BreakType.
SquareupApi.GetBreakTypeById	Retrieve details of a specific BreakType by ID.
SquareupApi.UpdateBreakType	Update an existing BreakType configuration.
SquareupApi.CreateScheduledShift	Create a scheduled shift with draft shift details.
SquareupApi.BulkPublishScheduledShifts	Publish multiple scheduled shifts in bulk.
SquareupApi.ListScheduledShifts	Retrieve a list of scheduled shifts with filtering options.
SquareupApi.RetrieveScheduledShift	Retrieve details of a scheduled shift by ID.
SquareupApi.UpdateScheduledShift	Updates draft shift details for a scheduled shift.
SquareupApi.PublishScheduledShift	Publish a scheduled shift to make it official.
SquareupApi.ListTeamMemberWages	Retrieve paginated list of team member wages for a business.
SquareupApi.GetTeamMemberWage	Retrieve wage details for a specific team member.
SquareupApi.CreateTeamMemberTimecard	Create a timecard for a team member's workday.
SquareupApi.SearchTimecards	Retrieve filtered and sorted timecard records for a business.
SquareupApi.DeleteTimecard	Delete a specific timecard entry.
SquareupApi.GetTimecardById	Fetch details of a specific timecard by ID.
SquareupApi.UpdateTimecard	Update an existing timecard with new details.
SquareupApi.ListWorkweekConfigs	Retrieve workweek configurations for a business.
SquareupApi.UpdateWorkweekConfiguration	Update workweek configuration settings.
SquareupApi.ListAllLocations	Fetch details of all seller's locations, including inactive ones.
SquareupApi.CreateNewLocation	Create a new location for sales and configuration.
SquareupApi.ListLocationCustomAttributeDefinitions	Get location-related custom attribute definitions for a Square account.
SquareupApi.CreateLocationCustomAttribute	Create a custom attribute for a Square location.
SquareupApi.DeleteLocationCustomAttribute	Delete a custom attribute definition from a location.
SquareupApi.RetrieveLocationCustomAttributeDefinition	Retrieve a location's custom attribute definition.
SquareupApi.UpdateLocationCustomAttribute	Updates a custom attribute definition for a location.
SquareupApi.BulkDeleteLocationCustomAttributes	Delete custom attributes for multiple locations at once.
SquareupApi.BulkUpsertLocationCustomAttributes	Bulk create or update custom attributes for multiple locations.
SquareupApi.RetrieveLocationDetails	Retrieve details of a specific business location.
SquareupApi.UpdateLocationSquareup	Updates a business location on Square.
SquareupApi.ListLocationCustomAttributes	Retrieve custom attributes for a specific location.
SquareupApi.RemoveLocationCustomAttribute	Delete a custom attribute from a location.
SquareupApi.GetLocationCustomAttribute	Retrieve a custom attribute for a specific location.
SquareupApi.UpsertLocationCustomAttribute	Create or update a custom attribute for a location.
SquareupApi.CreateLoyaltyAccount	Create a loyalty account for a buyer.
SquareupApi.SearchLoyaltyAccounts	Search for loyalty accounts by phone number or customer ID.
SquareupApi.RetrieveLoyaltyAccount	Retrieve details of a specific loyalty account.
SquareupApi.AccumulateLoyaltyPoints	Add points to a loyalty account for a purchase.
SquareupApi.AdjustLoyaltyPoints	Manually adjust loyalty points for a buyer's account.
SquareupApi.SearchLoyaltyEvents	Retrieve and search for Square loyalty events.
SquareupApi.GetLoyaltyProgram	Retrieve the loyalty program details for a seller.
SquareupApi.CalculateLoyaltyPoints	Calculate loyalty points a buyer can earn from a purchase.
SquareupApi.ListLoyaltyPromotions	Retrieve promotions from a specific loyalty program.
SquareupApi.CreateLoyaltyPromotion	Create a new loyalty promotion for a program.
SquareupApi.RetrieveLoyaltyPromotion	Retrieve details of a specific loyalty promotion.
SquareupApi.CancelLoyaltyPromotion	Cancels an active or scheduled loyalty promotion early.
SquareupApi.CreateLoyaltyReward	Create a loyalty reward by locking points for a customer.
SquareupApi.SearchLoyaltyRewards	Search for loyalty rewards with optional filters.
SquareupApi.DeleteLoyaltyReward	Deletes a loyalty reward and restores points to the account.
SquareupApi.GetLoyaltyReward	Retrieve details of a specific loyalty reward.
SquareupApi.RedeemLoyaltyReward	Redeem a loyalty reward for a customer purchase.
SquareupApi.GetMerchantDetails	Retrieve details about a specific merchant.
SquareupApi.ListMerchantCustomAttributeDefinitions	Retrieve merchant custom attribute definitions.
SquareupApi.CreateMerchantCustomAttribute	Create a custom attribute for a Square merchant account.
SquareupApi.DeleteMerchantCustomAttribute	Delete a custom attribute definition for a Square merchant.
SquareupApi.GetMerchantCustomAttributeDefinition	Retrieves custom attribute definition for a Square seller account.
SquareupApi.UpdateMerchantCustomAttributeDefinition	Updates a merchant's custom attribute definition.
SquareupApi.BulkDeleteMerchantCustomAttributes	Bulk delete custom attributes for a merchant.
SquareupApi.UpsertMerchantCustomAttributesBulk	Bulk creates or updates custom attributes for a merchant.
SquareupApi.RetrieveMerchantInfo	Retrieve merchant details using their ID.
SquareupApi.ListMerchantCustomAttributes	Retrieve custom attributes for a specified merchant.
SquareupApi.RemoveMerchantAttribute	Delete a custom attribute from a merchant.
SquareupApi.RetrieveMerchantCustomAttribute	Retrieve a custom attribute associated with a merchant.
SquareupApi.UpsertMerchantCustomAttribute	Create or update a custom attribute for a merchant.
SquareupApi.RetrieveLocationSettings	Retrieve settings for a Square-hosted checkout page location.
SquareupApi.UpdateCheckoutLocationSettings	Update location settings for a Square-hosted checkout page.
SquareupApi.RetrieveSquareMerchantSettings	Retrieve Square merchant settings for checkout pages.
SquareupApi.UpdateMerchantSettings	Updates Square-hosted checkout page settings for a merchant.
SquareupApi.ListPaymentLinks	Lists all online payment links for Squareup.
SquareupApi.CreatePaymentLink	Create a Square-hosted checkout page for payments.
SquareupApi.DeletePaymentLink	Deletes a specified payment link.
SquareupApi.RetrievePaymentLink	Retrieve a payment link using its ID.
SquareupApi.UpdatePaymentLink	Update details of an existing payment link.
SquareupApi.CreateOrderForPurchase	Creates a new order for purchase with product details.
SquareupApi.RetrieveMultipleOrders	Retrieve multiple orders using their IDs.
SquareupApi.PreviewOrderPricing	Preview order pricing without creating an order.
SquareupApi.CloneOrderDraft	Clone an existing order as a draft.
SquareupApi.ListOrderCustomAttributeDefinitions	Retrieve order-related custom attribute definitions for a Square seller.
SquareupApi.CreateOrderCustomAttribute	Define a custom attribute for Square orders.
SquareupApi.DeleteOrderCustomAttributeDefinition	Delete a custom attribute definition from an order.
SquareupApi.RetrieveOrderCustomAttributeDefinition	Retrieve a custom attribute definition for an order.
SquareupApi.UpdateOrderCustomAttributeDefinition	Modify order-related custom attribute definitions.
SquareupApi.BulkDeleteOrderCustomAttributes	Perform bulk deletion of custom attributes from orders.
SquareupApi.BulkUpsertOrderCustomAttributes	Perform bulk create or update of order custom attributes.
SquareupApi.SearchSquareOrders	Search and retrieve orders from Square locations.
SquareupApi.RetrieveOrderById	Retrieve an order's details using its ID.
SquareupApi.UpdateOrderSquare	Update fields of an open Square order.
SquareupApi.ListOrderCustomAttributes	Retrieve custom attributes associated with an order.
SquareupApi.DeleteOrderCustomAttribute	Delete a custom attribute from an order profile.
SquareupApi.RetrieveOrderCustomAttribute	Retrieve a custom attribute for a specified order.
SquareupApi.UpdateOrderCustomAttribute	Create or update a custom attribute for an order.
SquareupApi.PayOrder	Settle an order using approved payments.
SquareupApi.RetrievePaymentsList	Retrieve a list of payments from your account.
SquareupApi.CreatePayment	Create a payment using credit/debit card or other sources.
SquareupApi.CancelPaymentByIdempotency	Cancel a payment by idempotency key when status is unknown.
SquareupApi.GetPaymentDetails	Retrieve detailed information about a specific payment.
SquareupApi.UpdatePaymentStatus	Update a payment's approved status and details.
SquareupApi.CancelPayment	Cancel or void an approved payment.
SquareupApi.CompletePayment	Complete an approved payment using Squareup.
SquareupApi.ListPayouts	Retrieve a list of payouts for the default location.
SquareupApi.GetPayoutDetails	Retrieve details of a specific payout using payout ID.
SquareupApi.ListPayoutEntries	Retrieve all payout entries for a specific payout.
SquareupApi.ListPaymentRefunds	Retrieve a list of payment refunds for the account.
SquareupApi.RefundPayment	Refund a payment partially or fully using Square.
SquareupApi.RetrieveRefundDetails	Retrieve details of a specific refund using the refund ID.
SquareupApi.ListSquareOnlineSites	List all Square Online sites for a seller.
SquareupApi.DeleteSquareSnippet	Delete a snippet from a Square Online site.
SquareupApi.RetrieveOnlineSiteSnippet	Retrieve a specific snippet from a Square Online site.
SquareupApi.AddOrUpdateSquareOnlineSnippet	Add or update a snippet on a Square Online site.
SquareupApi.CreateCustomerSubscription	Enroll a customer in a subscription plan.
SquareupApi.BulkSwapSubscriptionPlan	Schedule a plan variation swap for multiple subscriptions.
SquareupApi.SearchSubscriptions	Search for subscriptions by location and customer IDs.
SquareupApi.RetrieveSubscriptionDetails	Retrieve details of a specific subscription using its ID.
SquareupApi.UpdateSubscription	Update subscription details with new or cleared values.
SquareupApi.DeleteSubscriptionAction	Delete a scheduled action for a subscription.
SquareupApi.ChangeBillingAnchorDate	Change the billing anchor date for a subscription.
SquareupApi.CancelSubscription	Cancel an active subscription at the end of the billing period.
SquareupApi.ListSubscriptionEvents	Retrieve all events for a specific subscription.
SquareupApi.PauseSubscription	Schedule a pause for an active subscription.
SquareupApi.ResumeSubscription	Resume a paused or deactivated subscription.
SquareupApi.SwapSubscriptionPlan	Swap a subscription plan variation for an existing subscription.
SquareupApi.CreateTeamMember	Create a new team member with given and family names.
SquareupApi.BulkCreateTeamMembers	Create multiple team members in bulk.
SquareupApi.BulkUpdateTeamMembers	Update multiple team members in bulk.
SquareupApi.ListJobs	Retrieve jobs from a seller's account, sorted by title.
SquareupApi.CreateJobInSellerAccount	Create a job for a seller account.
SquareupApi.RetrieveJobDetails	Retrieve details of a specified job.
SquareupApi.UpdateJobDetails	Update job title or tip eligibility in the system.
SquareupApi.SearchTeamMembers	Retrieve a filtered list of team members for a business.
SquareupApi.GetTeamMemberDetails	Retrieve details for a specific team member by ID.
SquareupApi.UpdateTeamMember	Updates a single TeamMember object.
SquareupApi.RetrieveTeamMemberWageSetting	Retrieve wage settings for a specified team member.
SquareupApi.UpdateWageSetting	Create or update a team member's wage setting.
SquareupApi.CreateTerminalAction	Create and send a terminal action request to a device.
SquareupApi.SearchTerminalActions	Retrieve a filtered list of terminal action requests.
SquareupApi.RetrieveTerminalAction	Retrieve a Terminal action request by action ID.
SquareupApi.CancelTerminalAction	Cancel a terminal action request if possible.
SquareupApi.DismissTerminalAction	Dismiss a Terminal action request if permitted.
SquareupApi.CreateTerminalCheckout	Create a Terminal checkout request for payment.
SquareupApi.SearchTerminalCheckouts	Retrieve filtered Terminal checkout requests for the merchant.
SquareupApi.RetrieveTerminalCheckout	Retrieve a Terminal checkout request by checkout ID.
SquareupApi.CancelTerminalCheckout	Cancel a terminal checkout request if possible.
SquareupApi.DismissTerminalCheckout	Dismiss a Terminal checkout request.
SquareupApi.CreateTerminalRefund	Creates a refund request for Interac payments on Square Terminal.
SquareupApi.SearchTerminalRefunds	Retrieve a filtered list of Interac Terminal refund requests.
SquareupApi.GetTerminalRefund	Retrieve details of an Interac Terminal refund by ID.
SquareupApi.CancelTerminalRefund	Cancel a terminal refund request by its ID.
SquareupApi.DismissTerminalRefund	Dismiss a Terminal refund request.
SquareupApi.CreateTransferOrder	Create a draft transfer order between locations.
SquareupApi.SearchTransferOrders	Search for transfer orders using specific filters.
SquareupApi.DeleteDraftTransferOrder	Delete a draft transfer order and trigger webhook event.
SquareupApi.RetrieveTransferOrderDetails	Retrieve detailed information of a specific transfer order.
SquareupApi.UpdateTransferOrder	Update specific fields of a transfer order.
SquareupApi.CancelTransferOrder	Cancel a transfer order in progress for inventory locations.
SquareupApi.RecordTransferOrderReceipt	Record received items for a transfer order.
SquareupApi.StartTransferOrder	Start a transfer order to mark it as in-transit.
SquareupApi.BulkCreateVendors	Create multiple vendor profiles for suppliers.
SquareupApi.RetrieveVendors	Retrieve detailed information about specific vendors.
SquareupApi.BulkUpdateVendors	Update multiple vendor records simultaneously.
SquareupApi.CreateVendor	Create a vendor for a supplier to a seller.
SquareupApi.SearchVendors	Search for vendors using filters and sorters.
SquareupApi.RetrieveVendorDetails	Retrieve detailed information about a vendor by ID.
SquareupApi.UpdateVendorInfo	Update an existing vendor's information.
SquareupApi.ListWebhookEventTypes	Retrieve all webhook event types available for subscription.
SquareupApi.ListWebhookSubscriptions	Lists all webhook subscriptions owned by the application.
SquareupApi.CreateWebhookSubscription	Creates a webhook subscription.
SquareupApi.DeleteWebhookSubscription	Deletes a specified webhook subscription.
SquareupApi.RetrieveWebhookSubscription	Retrieve details of a specific webhook subscription.
SquareupApi.UpdateWebhookSubscription	Update a webhook subscription to modify its settings.
SquareupApi.UpdateWebhookSignatureKey	Update a webhook subscription's signature key.
SquareupApi.TestWebhookSubscription	Send a test event to a webhook subscription URL.

If you need to perform an action that’s not listed here, you can get in touch with us to request a new , or create your own tools.

SquareupApi.RevokeOauthAccessToken

Revoke all OAuth access tokens for an .

Parameters

application_client_id (string, optional) The Square-issued ID for your application, found on the OAuth page in the Developer Dashboard.
merchant_access_token (string, optional) The access token of the merchant whose token you want to revoke. Cannot be used with merchant_id.
merchant_id_to_revoke (string, optional) The merchant ID whose token you want to revoke. Do not use if ‘access_token’ is provided.
terminate_single_access_token (boolean, optional) If true, terminate only the specified access token without revoking the entire authorization. Defaults to false.

SquareupApi.ObtainOauthToken

Obtain OAuth access and refresh tokens.

Parameters

application_id (string, required) The Square-issued ID of your application, available as the Application ID in the Developer Console. Required for code and PKCE flows.
oauth_grant_type (string, required) Specifies the method for obtaining an OAuth access token. Choose from ‘authorization_code’, ‘refresh_token’, or ‘migration_token’.
application_client_secret (string, optional) The application’s secret key from the Developer Console, required for code flow. Distinct from a personal access token.
application_redirect_url (string, optional) The registered redirect URL for your application. Required for code flow and PKCE flow if grant_type is authorization_code.
authorization_code (string, optional) The authorization code for exchanging an OAuth access token, required for code flow and PKCE flow if grant_type is authorization_code.
expire_token_in_24_hours (boolean, optional) Set to true to make the access token expire in 24 hours. Optional for any grant type.
legacy_migration_token (string, optional) A valid legacy access token for generating a new OAuth access token, required if grant_type is migration_token.
pkce_code_verifier (string, optional) The secret your application generated for the authorization request, required for PKCE flow when grant_type is authorization_code.
requested_scopes (array[string], optional) List of permissions for the access token, like [“MERCHANT_PROFILE_READ”, “PAYMENTS_READ”]. Optional for certain flows.
valid_refresh_token (string, optional) A valid refresh token used to generate a new OAuth access token, returned in a previous ObtainToken response. Required for the code and PKCE flow if grant_type is refresh_token.

SquareupApi.RetrieveTokenStatus

Retrieve the status of an OAuth or personal access token.

Parameters

This does not take any parameters.

SquareupApi.ActivateDomainForApplePay

Activates a domain for use with Apple Pay and Square.

Parameters

apple_pay_domain_name (string, required) Enter the domain name, as per RFC-1034, to register it with Apple Pay.

SquareupApi.ListBankAccounts

Fetches bank accounts linked to a Square .

Parameters

location_id_filter (string, optional) Specify this optional filter to retrieve bank linked to a specific location.
max_bank_accounts (integer, optional) Specify the maximum number of bank to return. The limit can be up to 1000, which is also the default.
pagination_cursor (string, optional) The pagination cursor from a previous ListBankAccounts call to retrieve the next set of results.

SquareupApi.GetBankAccountDetailsByV1Id

Fetches bank details using a V1 ID.

Parameters

v1_bank_account_id (string, required) The V1 ID of the bank to retrieve details for. This ID is used to fetch specific account information from the Squareup service.

SquareupApi.GetBankAccountDetails

Retrieve details of a bank linked to a Square account.

Parameters

bank_account_id (string, required) Square-issued ID of the desired bank to retrieve its details.

SquareupApi.RetrieveBookings

Retrieve a collection of bookings.

Parameters

customer_id_for_bookings (string, optional) The ID of the customer for whom to retrieve bookings. If not provided, retrieves bookings for all customers.
earliest_start_time (string, optional) The RFC 3339 timestamp specifying the earliest start time for bookings. Defaults to current time if not set.
latest_start_time (string, optional) The latest possible start time of bookings in RFC 3339 format. Defaults to 31 days after start_at_min if not set.
max_results_per_page (integer, optional) The maximum number of results per page to return in a paged response.
pagination_cursor (string, optional) The pagination cursor for the next page of results. Leave empty for the first page.
specific_location_id (string, optional) Retrieve bookings for a specific location by its ID. If not set, retrieves bookings for all locations.
team_member_id (string, optional) The ID of the team member to retrieve bookings for. Leave unset to retrieve bookings for all members.

SquareupApi.CreateBooking

Create a new booking for a service.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchBookingAvailability

Find available booking slots for appointments.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkRetrieveBookings

Retrieve multiple bookings using booking IDs.

Parameters

booking_ids (array[string], required) A non-empty list of booking IDs to retrieve the corresponding bookings.

SquareupApi.RetrieveBookingProfile

Retrieve a seller’s booking profile information.

Parameters

This does not take any parameters.

SquareupApi.ListBookingCustomAttributeDefinitions

Retrieve all custom attribute definitions for bookings.

Parameters

pagination_cursor (string, optional) Cursor from the previous response to get the next page of results.
result_limit (integer, optional) Maximum results to return per page. Must be between 1 and 100, default is 20.

SquareupApi.CreateBookingCustomAttribute

Creates a custom attribute definition for bookings.

Parameters

attribute_schema_json (json, optional) The JSON schema defining data type for booking custom attributes. Required for attribute creation. For more, visit Squareup Custom Attributes Overview.
current_attribute_definition_version (integer, optional) The current version of the custom attribute definition. Must be set to the latest version for updates and strong consistency.
custom_attribute_created_timestamp (string, optional) The creation timestamp of the custom attribute definition in RFC 3339 format.
custom_attribute_definition_name (string, optional) The name for the custom attribute definition. Must be unique within the seller and application pair and required if visibility is ‘VISIBILITY_READ_ONLY’ or ‘VISIBILITY_READ_WRITE_VALUES’.
custom_attribute_description (string, optional) A description for the custom attribute, required if visibility is read-only or read-write. Displayed as a tooltip in UIs.
custom_attribute_key (string, optional) Identifier for the custom attribute definition. Use a simple or qualified key. Must be unique and cannot be changed later.
custom_attribute_visibility (string, optional) Defines the permission level required to view the custom attribute. Options: VISIBILITY_HIDDEN, VISIBILITY_READ_ONLY, VISIBILITY_READ_WRITE_VALUES.
idempotency_key (string, optional) A unique string identifier for the request to ensure idempotency. This prevents duplicate operations in case of retries.
updated_at_timestamp (string, optional) The timestamp in RFC 3339 format indicating when the custom attribute definition was last updated or created.

SquareupApi.DeleteBookingCustomAttributeDefinition

Deletes a booking’s custom attribute definition.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to delete for bookings.

SquareupApi.RetrieveBookingCustomAttributeDefinition

Retrieve a booking’s custom attribute definition.

Parameters

custom_attribute_key (string, required) The key for the custom attribute definition to retrieve. Use a qualified key if not the definition owner.
current_version_of_custom_attribute_definition (integer, optional) The current version of the custom attribute definition for consistent reads. Provides the specified version or higher if available. Returns BAD_REQUEST if the version is higher than current.

SquareupApi.UpdateBookingCustomAttribute

Update a booking’s custom attribute definition.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to update. This key can be a simple key or a qualified key consisting of the application ID and the simple key, formatted as ‘application_id:simple_key’.
created_at_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format. This is used to track the original creation time of the attribute definition.
current_version_of_custom_attribute_definition (integer, optional) Specify the current version of the custom attribute definition to enable optimistic concurrency. Must match the latest version; stale writes are rejected.
custom_attribute_definition_key (string, optional) The key of the custom attribute definition, either as a simple key or in the format ‘application_id:simple key’. Unique per application, seller, and resource type.
custom_attribute_definition_name (string, optional) The unique name for the booking’s custom attribute definition, required if visibility is set to read-only or read-write.
custom_attribute_description (string, optional) A seller-oriented description of the custom attribute, required if visibility is read-only or read-write.
custom_attribute_schema (json, optional) A JSON object defining the schema for the custom attribute, determining its data type. Required for creating a definition.
idempotency_token (string, optional) A unique string identifier for ensuring the request is idempotent. Refer to Square’s Idempotency guidelines for details.
updated_timestamp (string, optional) The RFC 3339 formatted timestamp of the last update for the custom attribute definition.
visibility_level (string, optional) Specifies permission level for viewing the custom attribute definition. Options: VISIBILITY_HIDDEN, VISIBILITY_READ_ONLY, VISIBILITY_READ_WRITE_VALUES.

SquareupApi.BulkDeleteBookingCustomAttributes

Bulk delete custom attributes for bookings.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkUpsertBookingCustomAttributes

Bulk upserts custom attributes for bookings.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListSellerBookingProfiles

Retrieve booking profiles for seller locations.

Parameters

max_results_per_page (integer, optional) The maximum number of booking profiles to return in a single response page.
pagination_cursor (string, optional) Use this to fetch the next page of results. Leave blank for the first page.

SquareupApi.RetrieveSellerLocationBookingProfile

Retrieve a seller’s location booking profile.

Parameters

location_id (string, required) The ID of the location for which to retrieve the booking profile.

SquareupApi.ListBookingProfiles

Retrieve booking profiles for team members.

Parameters

filter_by_location_id (string, optional) Filter to return only team members enabled at the specified location ID.
include_only_bookable_members (boolean, optional) Set to true to include only team members who are bookable. False includes all members.
maximum_results_limit (integer, optional) Specify the maximum number of results to return in a paged response.
pagination_cursor (string, optional) The cursor for pagination to retrieve the next page of results. Omit for the first page of results.

SquareupApi.RetrieveTeamBookingProfiles

Retrieve booking profiles for one or more team members.

Parameters

team_member_ids (array[string], required) A non-empty list of team member IDs to retrieve booking profiles for.

SquareupApi.GetTeamMemberBookingProfile

Retrieve a team member’s booking profile from Square.

Parameters

team_member_unique_id (string, required) The unique identifier for the team member whose booking profile is being retrieved.

SquareupApi.RetrieveBooking

Retrieve detailed information about a booking.

Parameters

booking_id (string, required) The ID of the Booking object to retrieve details for.

SquareupApi.UpdateBooking

Update an existing booking with new details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
booking_identifier (string, optional) The unique identifier of the booking to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CancelBooking

Cancel an existing booking.

Parameters

booking_id (string, required) The unique ID of the booking to be canceled. This ID is required to identify which booking to cancel.
booking_revision_number (integer, optional) The current revision number of the booking for optimistic concurrency control.
idempotency_key (string, optional) Unique key to ensure the request is idempotent and prevents duplicate operations.

SquareupApi.ListBookingCustomAttributes

Retrieve a booking’s custom attributes.

Parameters

booking_id (string, required) The unique identifier for the target booking to list custom attributes for. This is required to specify which booking’s attributes to retrieve.
include_custom_attribute_definitions (boolean, optional) Set to true to include custom attribute definitions, providing names, descriptions, data types, and other details. Default is false.
maximum_results_limit (integer, optional) The maximum number of results to return in a single response (1-100). Default is 20.
pagination_cursor (string, optional) The cursor from the previous API response used to retrieve the next page of results.

SquareupApi.DeleteBookingCustomAttribute

Deletes a custom attribute from a booking.

Parameters

booking_id (string, required) The unique identifier for the booking from which the custom attribute will be deleted.
custom_attribute_key (string, required) The key of the custom attribute to delete. Must match the key in the Square seller . Use a qualified key if not the definition owner.

SquareupApi.RetrieveBookingCustomAttribute

Retrieve custom attributes of a booking.

Parameters

booking_id (string, required) The unique identifier for the target booking. This ID is required to retrieve the specific custom attribute for the booking.
custom_attribute_key (string, required) The key of the custom attribute to retrieve. Must match the key of a custom attribute definition in the Square seller . Use the qualified key if not the definition owner.
custom_attribute_version (integer, optional) The desired version for strong consistency reads of the custom attribute. Uses the specified version or a higher one if available.
include_custom_attribute_definition (boolean, optional) Set to true to include the custom attribute definition, providing name, description, and data type details. Default is false.

SquareupApi.SetBookingCustomAttribute

Upserts a custom attribute for a booking.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
booking_id (string, optional) The ID of the target booking to update or insert a custom attribute for. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
custom_attribute_key (string, optional) The key for the custom attribute to create or update, matching the existing key in the Square seller . Use the qualified key if not the definition owner. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListUserCards

Retrieve a list of cards owned by the .

Parameters

filter_by_customer_id (string, optional) Limit results to cards associated with a specific customer ID. By default, all cards owned by the merchant are returned.
include_disabled_cards (boolean, optional) Include disabled cards in the results. By default, only enabled cards are returned.
limit_to_reference_id (string, optional) Limit results to cards associated with the given reference ID. Use this to filter cards matching a specific reference.
pagination_cursor (string, optional) A string token to retrieve the next set of card results for pagination.
sort_order (string, optional) Specifies the sort order of the list by card creation date. Options are ‘ASC’ (ascending) or ‘DESC’ (descending). Defaults to ‘ASC’.

SquareupApi.AddCardToMerchant

Adds a card on file to an existing merchant.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveCardDetails

Retrieve details for a specific card.

Parameters

card_id (string, required) Unique ID for the desired card to retrieve its details.

SquareupApi.DisableCreditCard

Disable a credit card to prevent further charges.

Parameters

credit_card_id (string, required) Unique ID of the credit card to be disabled. This is required to specify the card to be deactivated.

SquareupApi.ListCashDrawerShifts

Retrieve cash drawer shift details for a location and date range.

Parameters

location_id (string, required) The unique identifier of the location to retrieve cash drawer shifts for.
exclusive_query_end_time (string, optional) The exclusive end time for the query on opened_at, provided in ISO 8601 format.
pagination_cursor (string, optional) Opaque cursor used for fetching the next page of results from the API.
results_per_page (integer, optional) Number of cash drawer shift events per page. Default is 200, with a maximum of 1000.
sort_order (string, optional) Specifies the order of cash drawer shifts based on their opened_at field. Options are ‘ASC’ for ascending and ‘DESC’ for descending. Default is ‘ASC’.
start_time (string, optional) The inclusive start time for the query in ISO 8601 format.

SquareupApi.RetrieveCashDrawerShiftSummary

Retrieve summary details for a specific cash drawer shift.

Parameters

location_identifier (string, required) The unique ID of the location to retrieve cash drawer shifts from.
shift_identifier (string, required) The unique ID of the specific cash drawer shift to retrieve details for.

SquareupApi.ListCashDrawerShiftEvents

Retrieve events for a specific cash drawer shift.

Parameters

location_id (string, required) The unique identifier for the location to retrieve cash drawer shift events from.
shift_id (string, required) The ID of the cash drawer shift to retrieve events for.
max_results_per_page (integer, optional) Number of results to return per page (default is 200, maximum is 1000).
pagination_cursor (string, optional) Opaque cursor for fetching the next page of cash drawer shift event results.

SquareupApi.DeleteCatalogItems

Deletes catalog items and their children by IDs.

Parameters

catalog_object_ids_to_delete (array[string], required) The IDs of the catalog objects to be deleted. Deletion is cascading, removing the item and dependent objects.

SquareupApi.RetrieveCatalogObjects

Retrieve detailed catalog objects by provided IDs.

Parameters

catalog_object_ids (array[string], required) An array of IDs representing the CatalogObjects to retrieve. Each ID must be a string.
catalog_version (integer, optional) The specific version of catalog objects to retrieve, allowing access to historical data. If omitted, the current version is used.
include_category_path_to_root (boolean, optional) Include the path_to_root list for each returned category instance if set to true. Shows the path from parent categories to root.
include_deleted_objects (boolean, optional) Set to true to include deleted objects (is_deleted attribute) in the response.
include_related_objects (boolean, optional) If true, include additional related objects in the response. These are objects referenced by ID, included one level deep. Defaults to false.

SquareupApi.BatchUpsertCatalogObjects

Batch create or update up to 10,000 catalog objects.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.GetSquareCatalogInfo

Retrieve Square Catalog API information and batch size limits.

Parameters

This does not take any parameters.

SquareupApi.ListCatalogItems

Retrieve a list of catalog objects by type from Square catalog.

Parameters

catalog_object_types (string, optional) A case-insensitive, comma-separated list of object types to retrieve. Valid types include ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE, etc. Defaults to top-level types if unspecified.
catalog_version_number (integer, optional) Specify the catalog version number to retrieve historical objects. If omitted, retrieves current version.
pagination_cursor (string, optional) The cursor for pagination from a previous response. Leave unset for the initial request. Page size is 100.

SquareupApi.UpsertCatalogObject

Create or update a catalog object in Squareup.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.DeleteCatalogObject

Delete a catalog object and its children by ID.

Parameters

catalog_object_id (string, required) The unique ID of the catalog object to delete. Deletion is cascading, removing all dependent objects.

SquareupApi.GetCatalogItemInfo

Retrieve detailed information for a specific catalog item.

Parameters

catalog_object_id (string, required) The object ID of the catalog item to retrieve detailed information for.
catalog_version (integer, optional) Specify a catalog version to retrieve historical object data. If not provided, the current catalog version is used.
include_category_path_to_root (boolean, optional) Include the category’s path to the root in the response to show its hierarchy. Returns an empty list for top-level categories.
include_related_objects (boolean, optional) Set to true to include additional related objects, like associated categories, taxes, and images, in the response. Ideal for immediate display.

SquareupApi.SearchCatalogObjects

Search for catalog objects using specified query filters.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchCatalogItems

Find catalog items or variations based on search filters.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.UpdateItemModifierLists

Update modifier lists for a catalog item.

Parameters

catalog_item_ids (array[string], required) A list of catalog item IDs associated with the CatalogModifierList objects to update.
modifier_list_ids_to_disable (array[string], optional) The IDs of CatalogModifierList objects to disable for the CatalogItem. At least one of this or modifier_lists_to_enable must be specified.
modifier_list_ids_to_enable (array[string], optional) The IDs of the CatalogModifierList objects to enable for the CatalogItem. At least one of modifier_lists_to_enable or modifier_lists_to_disable must be specified.

SquareupApi.UpdateItemTaxes

Update tax settings for specified catalog items.

Parameters

catalog_item_ids (array[string], required) List of IDs for the CatalogItems associated with the CatalogTax objects being updated. Maximum of 1,000 IDs.
catalog_tax_ids_to_disable (array[string], optional) List of CatalogTax object IDs to disable. Specify either this or taxes_to_enable.
tax_ids_to_enable (array[string], optional) List of CatalogTax object IDs to enable. Must specify at least one if ‘tax_ids_to_disable’ is not provided.

SquareupApi.ListSalesChannels

Retrieve a list of available sales channels.

Parameters

channel_reference_type (string, optional) Type of reference associated with the sales channel, such as LOCATION or ONLINE_SITE.
channel_status (string, optional) Specify the status of the channel. Options are ‘ACTIVE’ or ‘INACTIVE’.
maximum_results_limit (integer, optional) Specify the maximum number of sales channels to return. Defaults to 100 if not provided.
next_page_cursor (string, optional) Provide the cursor to fetch the next set of results if pagination is needed.
reference_id (string, optional) ID of the reference associated with the sales channel.

SquareupApi.RetrieveSalesChannels

Retrieve bulk information about sales channels.

Parameters

channel_identifiers (array[string], required) A list of IDs representing sales channels to retrieve details for.

SquareupApi.RetrieveChannelInfo

Retrieve detailed information about a specific channel.

Parameters

channel_id (string, required) The unique identifier for the channel to retrieve information about.

SquareupApi.ListCustomerProfiles

Retrieve customer profiles from a Square .

Parameters

customer_sort_field (string, optional) Specifies the field by which customers should be sorted. Options: ‘DEFAULT’ or ‘CREATED_AT’. Default is ‘DEFAULT’.
customer_sort_order (string, optional) Specify sorting order for customers: ‘ASC’ for ascending or ‘DESC’ for descending. Default is ‘ASC’.
include_total_customer_count (boolean, optional) Set to true to include the total customer count in the response. Default is false.
max_results_per_page (integer, optional) Specify the maximum number of customer profiles to retrieve in a single page. Must be between 1 and 100. Default is 100.
pagination_cursor (string, optional) A pagination cursor from a previous request to retrieve the next set of results.

SquareupApi.CreateCustomer

Creates a new customer for a business in Square.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkCreateCustomers

Create multiple customer profiles in bulk.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkDeleteCustomers

Deletes multiple customer profiles at once.

Parameters

customer_profile_ids (array[string], required) Array of customer profile IDs to be deleted.

SquareupApi.BulkRetrieveCustomers

Retrieve multiple customer profiles using IDs.

Parameters

customer_ids (array[string], required) List of customer profile IDs to retrieve.

SquareupApi.UpdateMultipleCustomerProfiles

Update multiple customer profiles in one request.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListCustomerCustomAttributeDefinitions

Retrieve customer custom attribute definitions for a Square seller.

Parameters

max_results_per_page (integer, optional) Maximum number of results to return per page. It ranges from 1 to 100, defaulting to 20.
pagination_cursor (string, optional) Cursor from the previous response for pagination. Use it to get the next page of results.

SquareupApi.CreateCustomerAttributeDefinition

Create a custom attribute for customer profiles.

Parameters

attribute_definition_name (string, optional) The unique name of the custom attribute definition for both API and UI purposes. Required if visibility is set to ‘VISIBILITY_READ_ONLY’ or ‘VISIBILITY_READ_WRITE_VALUES’.
created_at_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format.
current_custom_attribute_version (integer, optional) The current version of the custom attribute definition. Incremental value used for optimistic concurrency control. Must be the latest version on writes to avoid rejection of stale updates.
custom_attribute_key (string, optional) Unique identifier for the custom attribute definition, either a simple or qualified key. Up to 60 characters, including alphanumeric, periods (.), underscores (_), and hyphens (-).
custom_attribute_schema (json, optional) The JSON schema defining the data type for the custom attribute. This is required when creating a definition.
custom_attribute_visibility (string, optional) Specify the level of permission required to view the custom attribute definition. Options include ‘VISIBILITY_HIDDEN’, ‘VISIBILITY_READ_ONLY’, and ‘VISIBILITY_READ_WRITE_VALUES’.
customer_attribute_description (string, optional) A description for the custom attribute definition, required if visibility is set to ‘VISIBILITY_READ_ONLY’ or ‘VISIBILITY_READ_WRITE_VALUES’. This serves as a seller-oriented tooltip.
idempotency_key (string, optional) A unique identifier for the request to prevent duplicate executions in case of retries. This is used for ensuring idempotency.
timestamp_updated_at (string, optional) Timestamp indicating when the custom attribute definition was created or updated, in RFC 3339 format.

SquareupApi.DeleteCustomerAttributeDefinition

Delete a customer custom attribute definition from Square.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to delete from a Square seller .

SquareupApi.GetCustomerCustomAttributeDefinition

Retrieve a customer’s custom attribute definition from Square.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to retrieve. Use the qualified key if not the owner.
custom_attribute_version (integer, optional) The current version of the custom attribute definition to ensure consistent reads. Use to check for the most up-to-date data.

SquareupApi.UpdateCustomerAttributeDefinition

Update customer custom attribute definitions for a Square seller.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to update. This should be either a simple or qualified key.
attribute_description (string, optional) Provide a seller-oriented description for the custom attribute. This may include constraints and will be displayed as a tooltip. Required if visibility is set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
attribute_visibility (string, optional) Defines who can read and write the custom attribute values and definition. Options are ‘VISIBILITY_HIDDEN’, ‘VISIBILITY_READ_ONLY’, or ‘VISIBILITY_READ_WRITE_VALUES’.
creation_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format.
current_version (integer, optional) The current version of the custom attribute definition, required for optimistic concurrency control. Must be set to the latest version to ensure updates are not stale. This helps enforce strong consistency during updates.
custom_attribute_definition_key (string, optional) The identifier for the custom attribute definition. It can be a simple key or a qualified key. The format is either ‘key’ or ‘application_id:key’. It must be unique and cannot be changed after creation.
custom_attribute_definition_name (string, optional) The name of the custom attribute definition for API and seller UI, unique within the seller and application pair. Required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
custom_attribute_definition_schema (json, optional) The JSON schema defining the data type of custom attributes. This is mandatory when creating a definition.
unique_request_identifier (string, optional) A unique identifier for this request to ensure idempotency. Prevents duplicate operations by using the same identifier for retries.
updated_timestamp (string, optional) The RFC 3339 format timestamp indicating when the custom attribute definition was last updated.

SquareupApi.BulkUpsertCustomerAttributes

Bulk create or update custom attributes for customer profiles.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListCustomerGroups

Retrieve a list of customer groups for a business.

Parameters

max_results_per_page (integer, optional) The maximum number of customer groups to return per page. Must be between 1 and 50.
pagination_cursor (string, optional) A pagination cursor to retrieve the next set of results from a previous query. Useful for handling paginated responses.

SquareupApi.CreateCustomerGroup

Creates a new customer group for a business.

Parameters

customer_group_name (string, required) The name of the customer group to be created. It is required for organizing customers into the group.
customer_group_id (string, optional) A unique Square-generated ID for the customer group. This is automatically generated by Square and is used to identify the customer group.
group_created_timestamp (string, optional) Specify the timestamp for when the customer group was created, in RFC 3339 format.
group_last_updated_time (string, optional) The timestamp when the customer group was last updated, in RFC 3339 format.
idempotency_key (string, optional) A unique string to ensure the request is processed only once. See Idempotency .

SquareupApi.DeleteCustomerGroup

Deletes a customer group by its ID.

Parameters

customer_group_id (string, required) The ID of the customer group you want to delete.

SquareupApi.GetCustomerGroup

Retrieve details of a specific customer group by group ID.

Parameters

customer_group_id (string, required) The unique ID of the customer group to retrieve details for.

SquareupApi.UpdateCustomerGroup

Updates a customer group by its ID.

Parameters

customer_group_id (string, required) The ID of the customer group to update.
customer_group_name (string, required) The new name for the customer group to be updated.
customer_group_unique_id (string, optional) A unique Square-generated ID for the customer group to be updated.
group_creation_timestamp (string, optional) The timestamp of when the customer group was created in RFC 3339 format. Required to track creation time.
group_last_updated_timestamp (string, optional) The timestamp when the customer group was last updated, in RFC 3339 format.

SquareupApi.SearchSquareCustomers

Search customer profiles in a Square .

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListCustomerSegments

Retrieve customer segments for a business.

Parameters

max_results_per_page (integer, optional) The maximum number of results to return in a single page. Value must be between 1 and 50. Default is 50.
pagination_cursor (string, optional) A pagination cursor for retrieving the next set of customer segment results. Use a cursor returned from a previous call to continue listing.

SquareupApi.GetCustomerSegment

Retrieve specific customer segment information.

Parameters

customer_segment_id (string, required) The Square-issued ID of the customer segment to retrieve.

SquareupApi.DeleteCustomerProfile

Delete a customer profile from a business system.

Parameters

customer_id (string, required) The ID of the customer to delete from the business system. Required for identifying the customer profile to remove.
customer_profile_version (integer, optional) The current version of the customer profile for optimistic concurrency control.

SquareupApi.RetrieveCustomerDetails

Retrieve detailed information for a specific customer.

Parameters

customer_id (string, required) The unique identifier of the customer to retrieve details for.

SquareupApi.UpdateCustomerProfile

Update a customer’s profile with new or changed details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
customer_id (string, optional) The unique identifier of the customer to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListCustomerCustomAttributes

Retrieve custom attributes of a customer profile.

Parameters

customer_profile_id (string, required) The unique identifier of the customer profile whose custom attributes are to be retrieved.
include_attribute_definitions (boolean, optional) Set to true to include custom attribute definitions in each custom attribute’s definition field. Default is false.
maximum_results_per_page (integer, optional) The maximum number of results to return in a single response. Valid values are 1 to 100, default is 20.
paging_cursor (string, optional) Cursor from the previous response to get the next page of results. Used for pagination.

SquareupApi.DeleteCustomerCustomAttribute

Deletes a custom attribute from a customer profile.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to delete. Must match the key of a custom attribute definition in the Square seller . Use the qualified key if not the definition owner.
customer_profile_id (string, required) The ID of the target customer profile for which the custom attribute will be deleted.

SquareupApi.GetCustomerCustomAttribute

Retrieve a custom attribute from a customer profile.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to retrieve. This must match an existing custom attribute key in the Square seller . Use a qualified key if not the definition owner.
customer_profile_id (string, required) The ID of the customer profile to retrieve the custom attribute from.
attribute_version (integer, optional) The version of the custom attribute for consistent reads. A higher version will return a BAD_REQUEST error.
include_custom_attribute_definition (boolean, optional) Set to true to include the custom attribute definition with name, description, data type, and other details. Default is false.

SquareupApi.UpdateCustomerCustomAttribute

Create or update a custom attribute for a customer profile.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
customer_identifier (string, optional) The ID of the target customer profile for which the custom attribute will be created or updated. This ID should match the customer profile in the Square system. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
custom_attribute_key (string, optional) The key identifying the custom attribute to create or update. Must match a key in the Square seller ’s custom attribute definition. Use a qualified key if the application is not the definition owner. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RemoveCustomerGroup

Remove a group membership from a customer.

Parameters

customer_id (string, required) The ID of the customer to remove from the group. Provide the unique identifier associated with the customer.
group_id (string, required) The unique identifier of the customer group to remove the customer from.

SquareupApi.AddGroupToCustomer

Adds a customer to a specified group.

Parameters

customer_group_id (string, required) The unique identifier of the group to which the customer will be added. This is necessary to specify the exact group for categorization purposes.
customer_id (string, required) The unique identifier of the customer to be added to the specified group.

SquareupApi.ListMerchantDevices

Retrieve a list of devices for a merchant’s terminal API.

Parameters

device_listing_order (string, optional) Specifies whether to list devices from oldest to newest (‘ASC’) or newest to oldest (‘DESC’).
filter_by_location_id (string, optional) Return devices only at the specified location ID, if provided.
pagination_cursor (string, optional) A string used to fetch the next set of device results. Obtained from a prior API call, it facilitates pagination.
results_page_limit (integer, optional) The number of results to return in a single page. Use this to control pagination of the device list.

SquareupApi.ListDeviceCodes

List all device codes for a merchant.

Parameters

device_code_status (string, optional) Filter DeviceCodes by statuses: ‘UNKNOWN’, ‘UNPAIRED’, ‘PAIRED’, or ‘EXPIRED’. Defaults to ‘PAIRED’ and ‘UNPAIRED’ if empty.
location_id_filter (string, optional) Filter to return only DeviceCodes from the specified location. Returns data from all locations if not provided.
pagination_cursor (string, optional) A pagination cursor from a previous call. Use to get the next set of results.
product_type_filter (string, optional) Specify the product type to filter DeviceCodes. Defaults to all if empty. Options include ‘TERMINAL_API’.

SquareupApi.CreateSquareTerminalDeviceCode

Generate a DeviceCode for Square Terminal login.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveDeviceCode

Retrieve device code details by ID.

Parameters

device_code_id (string, required) The unique identifier for the device code to retrieve its details.

SquareupApi.RetrieveDeviceById

Retrieve specific device information using its ID.

Parameters

device_identifier (string, required) The unique identifier for the device to retrieve information from Square’s system.

SquareupApi.GetAccountDisputes

Retrieve a list of disputes for an .

Parameters

dispute_states_filter (string, optional) Specify dispute states to filter the results. Options: INQUIRY_EVIDENCE_REQUIRED, INQUIRY_PROCESSING, INQUIRY_CLOSED, EVIDENCE_REQUIRED, PROCESSING, WON, LOST, ACCEPTED. Defaults to all states if not provided.
location_id (string, optional) The unique ID of the location to filter disputes for. If omitted, disputes from all locations are returned.
pagination_cursor (string, optional) A string cursor from a previous call to retrieve the next set of dispute results. See Pagination .

SquareupApi.RetrieveDisputeDetails

Retrieve details about a specific dispute using its ID.

Parameters

dispute_id (string, required) The unique identifier for the dispute you want to retrieve details about.

SquareupApi.AcceptDisputeLoss

Accept the loss on a dispute and update its status to ACCEPTED.

Parameters

dispute_id (string, required) The unique ID of the dispute to accept and resolve.

SquareupApi.GetDisputeEvidence

Retrieve evidence for a specific dispute.

Parameters

dispute_id (string, required) Specify the ID of the dispute to retrieve its associated evidence.
pagination_cursor (string, optional) A cursor for pagination. Provide this to retrieve the next set of results for the original query.

SquareupApi.UploadDisputeEvidenceText

Upload text evidence for a dispute challenge.

Parameters

dispute_id (string, required) The unique ID of the dispute to upload text evidence for.
evidence_text_string (string, required) Provide the textual evidence string to be used in the dispute challenge.
unique_request_key (string, required) A unique key for identifying and ensuring the idempotency of the request. For additional details, see Square’s idempotency documentation.
dispute_evidence_type (string, optional) Specify the type of evidence for the dispute. Options include: GENERIC_EVIDENCE, ONLINE_OR_APP_ACCESS_LOG, AUTHORIZATION_DOCUMENTATION, etc.

SquareupApi.RemoveDisputeEvidence

Removes specified evidence from a dispute in Square.

Parameters

dispute_id (string, required) The ID of the dispute to remove evidence from. Provide a valid string ID to specify the dispute.
evidence_id (string, required) The ID of the evidence to be removed from the dispute.

SquareupApi.GetDisputeEvidenceMetadata

Get metadata for specified dispute evidence.

Parameters

dispute_id (string, required) The unique ID of the dispute to retrieve evidence metadata from.
evidence_id (string, required) The unique identifier for the evidence to retrieve metadata for. Required to specify which evidence’s metadata is needed in the dispute.

SquareupApi.SubmitEvidenceToBank

Submit evidence for a dispute to the cardholder’s bank.

Parameters

dispute_identifier (string, required) The unique ID of the dispute for which evidence is being submitted.

SquareupApi.SearchSquareEvents

Search for Square API events within a specified timeframe.

Parameters

end_time_range (string, optional) A datetime in RFC 3339 format marking the end of the time range for the event search.
filter_by_location_ids (array[string], optional) An array of location IDs to filter events by specific locations.
filter_event_types (array[string], optional) A list of event types to filter the search results by. Each event type should be a string.
maximum_events_per_page (integer, optional) Specify the maximum number of events to return per page, up to 100.
merchant_ids_filter (array[string], optional) An array of merchant IDs used to filter events by merchant.
pagination_cursor (string, optional) A pagination cursor for retrieving the next set of events from a previous search query.
sort_key_for_event_search (string, optional) Set the key by which to sort the returned events. Options include ‘DEFAULT’.
sort_order (string, optional) Specify the order (chronological or alphabetical) for sorting results. Choose ‘ASC’ for ascending or ‘DESC’ for descending order.
time_range_start (string, optional) Datetime value in RFC 3339 format indicating the start of the event timeframe.

SquareupApi.DisableSearchableEvents

Disable events to prevent them from being searchable.

Parameters

This does not take any parameters.

SquareupApi.EnableEventsSearch

Enable events to make them searchable.

Parameters

This does not take any parameters.

SquareupApi.ListEventTypes

Retrieve available event types for webhooks and API queries.

Parameters

api_version (string, optional) Specify the API version to list event types, overriding the application’s default version.

SquareupApi.ListGiftCards

Retrieve and filter a list of gift cards.

Parameters

filter_by_customer_id (string, optional) Provide a customer ID to return only the gift cards linked to that specific customer.
gift_card_state (string, optional) Specify the state of the gift cards to filter the results by their current status. If not provided, all states are included.
gift_card_type (string, optional) Filter gift cards by a specified type, or return all types if not provided.
pagination_cursor (string, optional) A pagination cursor from a previous call to retrieve the next set of results. If not provided, returns the first page.
results_per_page_limit (integer, optional) Specify the number of gift cards to return per page. Maximum is 200; default is 30.

SquareupApi.CreateGiftCard

Create and register digital or physical gift cards.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListGiftCardActivities

Retrieve and filter gift card activities.

Parameters

activity_sort_order (string, optional) Specify the order to return gift card activities: ‘ASC’ for oldest to newest, ‘DESC’ for newest to oldest (default).
end_time_rfc3339 (string, optional) The inclusive end timestamp for the reporting period in RFC 3339 format. Defaults to current time.
filter_by_activity_type (string, optional) Specify a type of gift card activity to filter the results. If not provided, all activity types are returned.
filter_by_location_id (string, optional) Specify a location ID to filter gift card activities for that location. Leave empty for activities across all locations.
pagination_cursor (string, optional) A cursor returned by a previous call to paginate results. Use to retrieve the next set of results.
reporting_period_start_time (string, optional) The starting timestamp for filtering gift card activities, in RFC 3339 format. Inclusive of the provided time; defaults to one year ago.
results_limit_per_page (integer, optional) Specify the number of results per page. Maximum is 100; default is 50.
specific_gift_card_id (string, optional) Specify a gift card ID to retrieve activities related to that specific card. If not provided, activities for all gift cards will be returned.

SquareupApi.CreateGiftCardActivity

Creates a gift card activity to manage gift card balance or state.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveGiftCard

Retrieve a gift card using its number.

Parameters

gift_card_account_number (string, required) The number (GAN) of the gift card to retrieve. Max length 255 digits; Square-issued GANs have 16 digits.

SquareupApi.RetrieveGiftCardFromToken

Retrieve a gift card using a secure token.

Parameters

secure_payment_token (string, required) The secure payment token used to retrieve the gift card. Generated by the Web Payments SDK or In-App Payments SDK.

SquareupApi.LinkCustomerToGiftCard

Link a customer to a gift card for future use.

Parameters

customer_id (string, required) The ID of the customer to link to the gift card. This should be a unique identifier representing the customer in the system.
gift_card_identifier (string, required) The unique ID of the gift card to link to the customer.

SquareupApi.UnlinkCustomerFromGiftCard

Unlink a customer from a gift card.

Parameters

customer_id_to_unlink (string, required) The unique identifier of the customer to unlink from the gift card. Ensure it matches the correct customer.
gift_card_id_to_unlink (string, required) The ID of the gift card to be unlinked from the customer. Required for unlinking process.

SquareupApi.RetrieveGiftCardSquareup

Retrieve gift card details using a gift card ID.

Parameters

gift_card_id (string, required) The unique ID of the gift card to retrieve information.

SquareupApi.RetrieveInventoryAdjustment

Fetches inventory adjustment details by ID.

Parameters

inventory_adjustment_id (string, required) ID of the InventoryAdjustment to retrieve.

SquareupApi.ApplyInventoryAdjustments

Apply batch adjustments to inventory quantities.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.FetchInventoryChanges

Retrieve historical inventory changes and adjustments.

Parameters

filter_by_catalog_object_ids (array[string], optional) Filter results by providing an array of CatalogObject IDs. Only applicable when set.
filter_by_location_ids (array[string], optional) Return results filtered by specific Location IDs. This is optional and defaults to null.
filter_by_updated_before_timestamp (string, optional) Return results with created_at or calculated_at before this RFC 3339 timestamp.
filter_inventory_change_types (array[string], optional) A list of InventoryChangeType values to filter results, excluding TRANSFER. Default is [PHYSICAL_COUNT, ADJUSTMENT].
filter_updated_after_timestamp (string, optional) Return results with calculated_at after specified time in RFC 3339 format. Default is the UNIX epoch (1970-01-01T00:00:00Z).
inventory_states_filter (array[string], optional) Filter to return ADJUSTMENT query results by InventoryState. Only applies if set. Accepts a list of states.
number_of_records_to_return (integer, optional) The number of inventory change records to return in the response.
pagination_cursor (string, optional) A cursor for pagination to retrieve the next set of inventory results. Use this from a previous call to continue fetching data.

SquareupApi.RetrieveInventoryCounts

Retrieve current inventory counts for specific items and locations.

Parameters

filter_by_catalog_object_ids (array[string], optional) A list of CatalogObject IDs to filter the inventory results. Only applicable when set.
filter_by_location_ids (array[string], optional) An array of Location IDs to filter inventory counts. Only applicable when set.
filter_by_updated_after_timestamp (string, optional) Filter results to include only those with a calculated_at timestamp after the specified RFC 3339 time. Default is the UNIX epoch.
inventory_state_filters (array[string], optional) Filter results by specific inventory states. Ignored states: NONE, SOLD, UNLINKED_RETURN. Provide as an array of strings.
pagination_cursor (string, optional) A pagination cursor to retrieve the next set of results for the original query.
record_limit (integer, optional) Specify the number of inventory count records to return.

SquareupApi.GetInventoryPhysicalCount

Retrieve details of a specific inventory physical count.

Parameters

inventory_physical_count_id (string, required) ID of the InventoryPhysicalCount to retrieve details for.

SquareupApi.RetrieveInventoryTransfer

Retrieve detailed inventory transfer information.

Parameters

inventory_transfer_id (string, required) The unique identifier for the InventoryTransfer to retrieve.

SquareupApi.GetInventoryCount

Retrieve current stock count for a specific catalog item.

Parameters

catalog_object_id (string, required) The ID of the CatalogObject to retrieve inventory count for.
location_ids (string, optional) Comma-separated list of Location IDs to query. Use an empty list to query all locations.
pagination_cursor (string, optional) A cursor for paginating results, from previous call, to fetch next page.

SquareupApi.ListInvoices

Retrieve a list of invoices for a specified location.

Parameters

location_identifier (string, required) The unique identifier for the location to fetch invoices from.
maximum_invoices_to_return (integer, optional) Specify the maximum number of invoices to return. The limit is 200; default is 100 if not set.
pagination_cursor (string, optional) A cursor for pagination to retrieve the next set of invoice results.

SquareupApi.CreateDraftInvoice

Create a draft invoice for an order using Squareup.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchInvoices

Search for invoices based on location and optional customer.

Parameters

location_id (array[string], required) Specify the location ID to limit the invoice search. Only one location ID can be provided.
customer_id (array[string], optional) Specify the customer ID to limit the search to invoices for that customer. Only one customer can be specified.
maximum_invoice_count (integer, optional) The maximum number of invoices to return, up to 200. Defaults to 100 if not specified.
pagination_cursor (string, optional) A cursor to retrieve the next set of results for pagination. Use the cursor from the previous response.
sort_by_field (string, optional) Specify the field for sorting results. Default is ‘INVOICE_SORT_DATE’.
sort_order (string, optional) The order in which results are returned, either ‘DESC’ for descending or ‘ASC’ for ascending.

SquareupApi.DeleteInvoice

Delete a draft invoice and change order status to CANCELED.

Parameters

invoice_id (string, required) The ID of the draft invoice to delete.
invoice_version (integer, optional) The version number of the invoice to delete. Use GetInvoice or ListInvoices if unknown.

SquareupApi.RetrieveInvoiceById

Retrieve invoice details using an invoice ID.

Parameters

invoice_id (string, required) The ID of the invoice to retrieve. This should be a unique string representing a specific invoice.

SquareupApi.UpdateInvoice

Updates invoice details with specified changes.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
invoice_id (string, optional) The unique ID of the invoice you wish to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RemoveInvoiceAttachment

Removes an attachment from an invoice.

Parameters

attachment_id (string, required) The unique identifier for the invoice attachment to be deleted. Required for removing the specified file from the invoice.
invoice_identifier (string, required) The unique ID of the invoice from which to delete the attachment. Applicable for specific invoice states.

SquareupApi.CancelInvoice

Cancel an invoice to prevent further transactions.

Parameters

invoice_id (string, required) The ID of the invoice you want to cancel. This is required to specify which invoice will be affected.
invoice_version_to_cancel (integer, required) The version number of the invoice to be canceled. Use GetInvoice or ListInvoices to find it if unknown.

SquareupApi.PublishInvoice

Publish a draft invoice with Square, updating its status.

Parameters

invoice_id (string, required) The ID of the draft invoice that you wish to publish. This ID uniquely identifies the invoice within the system.
invoice_version (integer, required) Specify the current version number of the invoice to publish. This must match the existing invoice version to avoid rejection.
unique_request_identifier (string, optional) A unique string to identify the PublishInvoice request. If omitted or empty, each request is treated as independent. Refer to the Square documentation on idempotency for more information.

SquareupApi.ListBreakTypes

Retrieve a paginated list of break types for a business.

Parameters

filter_by_location_id (string, optional) Filter results to break types associated with the specified location ID.
max_results_per_page (integer, optional) Specify the maximum number of BreakType results to return per page. Must be between 1 and 200. Default is 200.
next_page_cursor (string, optional) A pointer to the next page of BreakType results to fetch for continued listing of break types.

SquareupApi.CreateBreakType

Create a new BreakType template for a location.

Parameters

break_expected_duration (string, required) The expected length of the break in RFC-3339 duration format (e.g., PT15M for 15 minutes).
break_name (string, required) A human-readable name for the break type, displayed to team members.
is_break_paid (boolean, required) Indicates if the break counts towards compensated work time. Use true for a paid break, false for an unpaid break.
location_id (string, required) The ID of the business location where this break type will apply. It is required to associate the break type with a specific location.
break_type_uuid (string, optional) The UUID for the BreakType object. It uniquely identifies the break type.
concurrency_version (integer, optional) Integer for resolving concurrency issues; fails if it doesn’t match server version.
created_at_timestamp (string, optional) A read-only timestamp in RFC 3339 format, automatically populated and not required for input.
idempotency_key (string, optional) A unique string to ensure the operation is idempotent, avoiding duplicate actions.
updated_at_timestamp (string, optional) A read-only timestamp in RFC 3339 format indicating when the BreakType was last updated.

SquareupApi.DeleteBreakType

Deletes an existing BreakType.

Parameters

break_type_uuid (string, required) The UUID of the BreakType to be deleted.

SquareupApi.GetBreakTypeById

Retrieve details of a specific BreakType by ID.

Parameters

break_type_uuid (string, required) The UUID of the BreakType to retrieve.

SquareupApi.UpdateBreakType

Update an existing BreakType configuration.

Parameters

break_counts_for_compensation (boolean, required) Set to true if this break counts towards time worked for compensation purposes.
break_duration_rfc3339 (string, required) The expected duration of the break in RFC-3339 format (e.g., PT15M for 15 minutes).
break_name (string, required) A human-readable name for the break type, shown to team members in Square products.
break_type_uuid (string, required) The UUID of the BreakType to be updated.
business_location_id (string, required) The ID of the business location this type of break applies to. Required for updating break settings.
break_type_creation_timestamp (string, optional) A read-only timestamp in RFC 3339 format indicating when the BreakType was created. This is not modifiable.
break_type_id (string, optional) The UUID for the BreakType object being updated. This is required for identifying which BreakType to modify.
readonly_updated_at_timestamp (string, optional) The read-only timestamp in RFC 3339 format indicating the last update time for BreakType. It’s not modifiable.
version_for_concurrency (integer, optional) The version number for concurrency control. Helps resolve conflicts by matching the server’s current version.

SquareupApi.CreateScheduledShift

Create a scheduled shift with draft shift details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkPublishScheduledShifts

Publish multiple scheduled shifts in bulk.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListScheduledShifts

Retrieve a list of scheduled shifts with filtering options.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveScheduledShift

Retrieve details of a scheduled shift by ID.

Parameters

scheduled_shift_id (string, required) The unique identifier of the scheduled shift to retrieve details for.

SquareupApi.UpdateScheduledShift

Updates draft shift details for a scheduled shift.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
scheduled_shift_id (string, optional) The unique identifier of the scheduled shift to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.PublishScheduledShift

Publish a scheduled shift to make it official.

Parameters

scheduled_shift_id (string, required) The ID of the scheduled shift to publish.
unique_idempotency_key (string, required) A unique identifier for ensuring the idempotency of the publish request. Prevents duplicate operations if the request is retried.
current_shift_version (integer, optional) The current version of the scheduled shift for optimistic concurrency control. If it doesn’t match the server version, the request fails.
notification_audience (string, optional) Specify who receives email notifications when a scheduled shift is published. Options are: ALL, AFFECTED, NONE.

SquareupApi.ListTeamMemberWages

Retrieve paginated list of team member wages for a business.

Parameters

filter_by_team_member_id (string, optional) Filter wages to only those associated with the specified team member by ID.
max_results_per_page (integer, optional) The maximum number of TeamMemberWage results to return per page, ranging from 1 to 200. Default is 200.
next_page_cursor (string, optional) A pointer to the next page of team member wage results to fetch.

SquareupApi.GetTeamMemberWage

Retrieve wage details for a specific team member.

Parameters

team_member_wage_id (string, required) The unique identifier (UUID) for retrieving the specific TeamMemberWage record.

SquareupApi.CreateTeamMemberTimecard

Create a timecard for a team member’s workday.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchTimecards

Retrieve filtered and sorted timecard records for a business.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.DeleteTimecard

Delete a specific timecard entry.

Parameters

timecard_uuid (string, required) The UUID for the Timecard being deleted.

SquareupApi.GetTimecardById

Fetch details of a specific timecard by ID.

Parameters

timecard_id (string, required) The unique UUID identifying the timecard you want to retrieve.

SquareupApi.UpdateTimecard

Update an existing timecard with new details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
timecard_id (string, optional) The unique identifier of the timecard to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListWorkweekConfigs

Retrieve workweek configurations for a business.

Parameters

maximum_results_per_page (integer, optional) Maximum number of WorkweekConfig results to return per page.
pagination_cursor (string, optional) Pointer to the next page of WorkweekConfig results to fetch.

SquareupApi.UpdateWorkweekConfiguration

Update workweek configuration settings.

Parameters

workweek_config_id (string, required) The UUID for the WorkweekConfig object to be updated.
workweek_start_day (string, required) Specifies the start day of the workweek. Acceptable values are: MON, TUE, WED, THU, FRI, SAT, SUN.
workweek_start_time_local (string, required) The local time a business week starts, represented as a string in HH:MM format (HH:MM:SS is accepted, but seconds are truncated).
read_only_updated_at (string, optional) A read-only timestamp in RFC 3339 format; presented in UTC, to indicate the last update time of the workweek configuration.
workweek_config_uuid (string, optional) The UUID of the workweek configuration object to be updated.
workweek_config_version (integer, optional) Version number to resolve concurrency issues. If it doesn’t match the server, the update fails. If omitted, a blind write occurs.
workweek_creation_timestamp (string, optional) Read-only UTC timestamp of workweek config creation in RFC 3339 format.

SquareupApi.ListAllLocations

Fetch details of all seller’s locations, including inactive ones.

Parameters

This does not take any parameters.

SquareupApi.CreateNewLocation

Create a new location for sales and configuration.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListLocationCustomAttributeDefinitions

Get location-related custom attribute definitions for a Square .

Parameters

filter_by_visibility (string, optional) Filter results by visibility values: ‘ALL’, ‘READ’, or ‘READ_WRITE’. Determines the visibility of custom attribute definitions returned.
maximum_results_per_page (integer, optional) Sets the maximum number of results to return in a single response page. Accepts values between 1 and 100, default is 20.
pagination_cursor (string, optional) The cursor from the previous response to fetch the next page of results.

SquareupApi.CreateLocationCustomAttribute

Create a custom attribute for a Square location.

Parameters

current_definition_version (integer, optional) The current version of the custom attribute definition. Must match the latest version for updates to ensure optimistic concurrency and avoid stale writes.
custom_attribute_definition_creation_timestamp (string, optional) The creation timestamp for the custom attribute definition in RFC 3339 format. Required for consistently tracking when the definition was created.
custom_attribute_description (string, optional) A seller-oriented description of the custom attribute definition. Required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. It may be shown as a tooltip in the Square UI.
custom_attribute_key (string, optional) The unique identifier for the custom attribute definition, formatted as ‘application_id:simple_key’ or a simple key with up to 60 characters including alphanumeric, periods, underscores, and hyphens.
custom_attribute_name (string, optional) The unique name for the custom attribute, used in API and UI. Required if visibility is not private.
custom_attribute_schema (json, optional) A JSON schema defining the data type of the custom attribute. It’s required for creating a definition.
custom_attribute_visibility (string, optional) Sets the permission level to view and edit the custom attribute. Options: VISIBILITY_HIDDEN, VISIBILITY_READ_ONLY, VISIBILITY_READ_WRITE_VALUES.
unique_request_id (string, optional) A unique identifier for this request to ensure idempotency. It helps prevent duplicate operations by distinguishing each request as unique.
updated_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created or last updated, in RFC 3339 format.

SquareupApi.DeleteLocationCustomAttribute

Delete a custom attribute definition from a location.

Parameters

custom_attribute_key (string, required) The identifier for the custom attribute definition to remove.

SquareupApi.RetrieveLocationCustomAttributeDefinition

Retrieve a location’s custom attribute definition.

Parameters

custom_attribute_key (string, required) The key for the custom attribute definition to retrieve, using the qualified key if not the owner.
current_custom_attribute_version (integer, optional) The version number of the custom attribute definition for consistent reads. Must match the current or higher version.

SquareupApi.UpdateLocationCustomAttribute

Updates a custom attribute definition for a location.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to update. It should match the key provided when the definition was created.
current_version (integer, optional) The current version of the custom attribute definition. Must be set to the latest version for updates to ensure optimistic concurrency.
custom_attribute_creation_timestamp (string, optional) The creation timestamp for the custom attribute definition in RFC 3339 format.
custom_attribute_definition_identifier (string, optional) The unique identifier for the custom attribute definition. This can be a simple key or a qualified key (format: application_id:simple_key). It supports up to 60 alphanumeric characters, periods (.), underscores (_), and hyphens (-).
custom_attribute_description (string, optional) A description for the custom attribute definition, including any constraints. Required if the visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
custom_attribute_name (string, optional) The unique name for the custom attribute definition. Required if visibility is set to specific levels.
custom_attribute_schema (json, optional) The JSON schema defining the data type of the custom attributes. Required when creating a definition. Refer to the Square Custom Attributes Overview for details.
custom_attribute_visibility_level (string, optional) Specifies permission level required to view the custom attribute definition. Options: VISIBILITY_HIDDEN, VISIBILITY_READ_ONLY, VISIBILITY_READ_WRITE_VALUES.
unique_idempotency_key (string, optional) A unique identifier for the request to ensure idempotency. Prevents duplicate processing of requests.
update_timestamp (string, optional) The timestamp indicating when the custom attribute definition was last updated, in RFC 3339 format.

SquareupApi.BulkDeleteLocationCustomAttributes

Delete custom attributes for multiple locations at once.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkUpsertLocationCustomAttributes

Bulk create or update custom attributes for multiple locations.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveLocationDetails

Retrieve details of a specific business location.

Parameters

location_id (string, required) The ID of the location to retrieve. Use “main” to return the main location details.

SquareupApi.UpdateLocationSquareup

Updates a business location on Square.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
location_id (string, optional) The ID of the location to update on Square. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListLocationCustomAttributes

Retrieve custom attributes for a specific location.

Parameters

location_id (string, required) The ID of the target location to retrieve custom attributes for.
filter_by_visibility (string, optional) Filters custom attribute definitions by visibility values. Options include ‘ALL’, ‘READ’, or ‘READ_WRITE’.
include_custom_attribute_definitions (boolean, optional) Set to true to include custom attribute definitions, providing name, description, and data type details. Defaults to false.
maximum_results_limit (integer, optional) The maximum number of results to return in a single response. Valid range: 1 to 100. Default is 20.
pagination_cursor (string, optional) The cursor for fetching the next page of results in a paginated response.

SquareupApi.RemoveLocationCustomAttribute

Delete a custom attribute from a location.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to delete, matching the key of a custom attribute definition in the Square seller . Use the qualified key if not the definition owner.
location_id (string, required) The unique identifier for the target location where the custom attribute will be deleted.

SquareupApi.GetLocationCustomAttribute

Retrieve a custom attribute for a specific location.

Parameters

custom_attribute_key (string, required) The key for the custom attribute to retrieve. Must match the key in Square’s custom attribute definition. Use qualified key if needed.
target_location_id (string, required) The ID of the target location to retrieve its custom attribute.
custom_attribute_version (integer, optional) Specify the current version of the custom attribute for consistent data retrieval. A BAD_REQUEST error is returned if this version exceeds the current version.
include_custom_attribute_definition (boolean, optional) Set to true to include details like name, description, and data type of the custom attribute definition. Default is false.

SquareupApi.UpsertLocationCustomAttribute

Create or update a custom attribute for a location.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
location_id (string, optional) The ID of the target location for which the custom attribute is to be created or updated. It should be a string that uniquely identifies the location within the Square seller . Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
custom_attribute_key (string, optional) The key for the custom attribute to create or update. Must match an existing attribute definition key in the Square . Use a qualified key if not the owner. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CreateLoyaltyAccount

Create a loyalty for a buyer.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchLoyaltyAccounts

Search for loyalty by phone number or customer ID.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveLoyaltyAccount

Retrieve details of a specific loyalty .

Parameters

loyalty_account_id (string, required) The unique identifier of the loyalty to retrieve.

SquareupApi.AccumulateLoyaltyPoints

Add points to a loyalty for a purchase.

Parameters

loyalty_account_id (string, required) The unique identifier for the target loyalty to which points will be added.
purchase_location_id (string, required) The ID of the location where the purchase was made, necessary for loyalty point accumulation.
unique_request_id (string, required) A unique string identifier for the AccumulateLoyaltyPoints request. Must be unique for each request to ensure idempotency.
loyalty_program_id (string, optional) The ID of the loyalty program to add points to. Required to identify the correct program.
order_id_for_accumulation (string, optional) The ID of the order for which points are accumulated. Required if using the Orders API.
points_to_accumulate (integer, optional) Specify the number of points to add to the loyalty from the purchase event if not using the Orders API.

SquareupApi.AdjustLoyaltyPoints

Manually adjust loyalty points for a buyer’s .

Parameters

loyalty_account_id (string, required) The unique ID of the buyer’s loyalty to adjust.
points_adjustment_amount (integer, required) The number of points to add or remove from the buyer’s .
unique_request_identifier (string, required) A unique string to identify this loyalty points adjustment request. Must be unique for each request to prevent duplicates.
adjustment_reason (string, optional) The reason for adjusting the loyalty points, such as ‘customer courtesy’ or ‘error correction’.
allow_negative_balance (boolean, optional) Set to true to allow a negative balance after point subtraction. Defaults to false if not specified.
loyalty_program_id (string, optional) The Square-assigned ID of the loyalty program to adjust points for.

SquareupApi.SearchLoyaltyEvents

Retrieve and search for Square loyalty events.

Parameters

end_time (string, optional) Datetime in RFC 3339 format indicating when the time range ends for the search.
location_ids_for_events_query (array[string], optional) List of Location IDs for querying loyalty events. Multiple IDs use OR logic.
loyalty_account_id (string, optional) The ID of the loyalty associated with the events to filter.
loyalty_event_types (array[string], optional) Array of loyalty event types to filter results. Multiple values are combined using OR logic. Refer to LoyaltyEventType for options.
max_results_count (integer, optional) The maximum number of loyalty events to include in the response. Defaults to 30.
order_id_filter (string, optional) The ID of the order associated with the event to filter results.
pagination_cursor (string, optional) Provide a pagination cursor to retrieve the next set of results from a previous query.
start_datetime (string, optional) A datetime value in RFC 3339 format indicating when the time range starts for the search query.

SquareupApi.GetLoyaltyProgram

Retrieve the loyalty program details for a seller.

Parameters

loyalty_program_identifier (string, required) The ID of the loyalty program or the keyword ‘main’. Use to retrieve the loyalty program of a seller.

SquareupApi.CalculateLoyaltyPoints

Calculate loyalty points a buyer can earn from a purchase.

Parameters

loyalty_program_id (string, required) The ID of the loyalty program, defining the rules for accruing points.
currency_code (string, optional) Indicates the associated currency for an amount of money using ISO 4217 codes. For example, ‘USD’ for United States Dollar.
loyalty_account_id (string, optional) The ID of the target loyalty . Optionally specify if using the Orders API. Determines promotion point eligibility based on trigger limits.
order_id (string, optional) The Order ID used to calculate points. Provide this if using the Orders API. Otherwise, use transaction_amount_money.
transaction_amount_in_smallest_denomination (integer, optional) The amount of money for the transaction, given in the smallest denomination of the currency (e.g., cents for USD).

SquareupApi.ListLoyaltyPromotions

Retrieve promotions from a specific loyalty program.

Parameters

loyalty_program_id (string, required) The ID of the loyalty program to list promotions for. Obtain via RetrieveLoyaltyProgram using main.
max_results_per_page (integer, optional) Specify the maximum number of promotions to return in a single response. Must be between 1 and 30, defaults to 30.
pagination_cursor (string, optional) The cursor for retrieving the next page of results from the previous call.
promotion_status_filter (string, optional) Specify the status to filter loyalty promotions. Options include ACTIVE, ENDED, CANCELED, SCHEDULED. Returns promotions with the specified status.

SquareupApi.CreateLoyaltyPromotion

Create a new loyalty promotion for a program.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
loyalty_program_id (string, optional) The ID of the loyalty program to associate with the promotion. Use the RetrieveLoyaltyProgram endpoint with the ‘main’ keyword to obtain it. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveLoyaltyPromotion

Retrieve details of a specific loyalty promotion.

Parameters

loyalty_program_id (string, required) The ID of the base loyalty program. Obtain this by calling the RetrieveLoyaltyProgram API using the ‘main’ keyword.
promotion_id (string, required) The ID of the loyalty promotion to retrieve. This ID is necessary to specify which promotion details to access.

SquareupApi.CancelLoyaltyPromotion

Cancels an active or scheduled loyalty promotion early.

Parameters

loyalty_program_id (string, required) The unique ID of the base loyalty program to identify which program the promotion is associated with.
loyalty_promotion_id (string, required) The ID of the loyalty promotion to cancel, which can be ‘ACTIVE’ or ‘SCHEDULED’.

SquareupApi.CreateLoyaltyReward

Create a loyalty reward by locking points for a customer.

Parameters

loyalty_account_id (string, required) The Square-assigned ID of the loyalty to which the reward belongs.
reward_tier_id (string, required) The Square-assigned ID of the reward tier used to create the loyalty reward.
unique_request_key (string, required) A unique string that identifies this CreateLoyaltyReward request. Must be unique for each request to prevent duplication.
loyalty_reward_id (string, optional) The Square-assigned ID of the loyalty reward to be created or referenced.
loyalty_reward_status (string, optional) The status of the loyalty reward. Possible values: ‘ISSUED’, ‘REDEEMED’, ‘DELETED’.
number_of_loyalty_points (integer, optional) The number of loyalty points to use for creating the reward.
order_id (string, optional) The Square-assigned ID of the order to which the reward is attached. Optional if no order is involved.
reward_creation_timestamp (string, optional) The timestamp when the reward was created, in RFC 3339 format. This indicates the date and time of reward creation.
reward_last_updated_timestamp (string, optional) The timestamp when the reward was last updated, in RFC 3339 format.
reward_redeemed_timestamp (string, optional) The timestamp when the reward was redeemed, in RFC 3339 format. This value indicates the moment the reward was used.

SquareupApi.SearchLoyaltyRewards

Search for loyalty rewards with optional filters.

Parameters

loyalty_account_id (string, optional) The ID of the loyalty to which the loyalty reward belongs. Required if using a query object.
maximum_results (integer, optional) The maximum number of loyalty reward results to return. Default is 30.
pagination_cursor (string, optional) A cursor for pagination to retrieve the next set of results from a previous call.
reward_status (string, optional) The status of the loyalty reward. Options: ISSUED, REDEEMED, DELETED.

SquareupApi.DeleteLoyaltyReward

Deletes a loyalty reward and restores points to the .

Parameters

loyalty_reward_id (string, required) The ID of the loyalty reward to delete, returning points to the . Cannot delete redeemed rewards.

SquareupApi.GetLoyaltyReward

Retrieve details of a specific loyalty reward.

Parameters

loyalty_reward_id (string, required) The ID of the loyalty reward to retrieve. This is required to fetch details about a specific reward for a customer.

SquareupApi.RedeemLoyaltyReward

Redeem a loyalty reward for a customer purchase.

Parameters

idempotency_key (string, required) A unique string to identify this RedeemLoyaltyReward request, ensuring uniqueness for each request.
location_id (string, required) The ID of the location where the loyalty reward is redeemed.
loyalty_reward_id (string, required) The unique ID of the loyalty reward to redeem. Required for specifying which reward to process.

SquareupApi.GetMerchantDetails

Retrieve details about a specific merchant.

Parameters

previous_response_cursor (integer, optional) The cursor generated by the previous response for fetching subsequent pages.

SquareupApi.ListMerchantCustomAttributeDefinitions

Retrieve merchant custom attribute definitions.

Parameters

max_results_per_page (integer, optional) The maximum number of results to return in a single response, ranging from 1 to 100. Default is 20.
pagination_cursor (string, optional) The cursor for retrieving the next page of results from a previous response.
visibility_filter_option (string, optional) Specify the visibility level of the CustomAttributeDefinition results. Options: ALL, READ, READ_WRITE.

SquareupApi.CreateMerchantCustomAttribute

Create a custom attribute for a Square merchant .

Parameters

attribute_visibility_level (string, optional) Specify the permission level required to view and edit the custom attribute: VISIBILITY_HIDDEN, VISIBILITY_READ_ONLY, or VISIBILITY_READ_WRITE_VALUES.
creation_timestamp (string, optional) The creation timestamp of the custom attribute definition in RFC 3339 format.
custom_attribute_definition_description (string, optional) The seller-oriented description for the custom attribute definition, including any constraints to observe. Required if visibility is ‘VISIBILITY_READ_ONLY’ or ‘VISIBILITY_READ_WRITE_VALUES’.
custom_attribute_definition_version (integer, optional) Read-only version of the custom attribute definition, required for updates to ensure optimistic concurrency control.
custom_attribute_json_schema (json, optional) The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. Required for creation.
custom_attribute_key (string, optional) The unique identifier for the custom attribute. Format: application_id:simple_key. Up to 60 characters, including ’.’, ’_’, ’-’. Must be unique per application, seller, and resource type.
custom_attribute_name (string, optional) The name of the custom attribute definition. It must be unique within the seller/application pair and is required if visibility is set to read-only or read-write.
idempotency_key (string, optional) A unique string identifier for the request to ensure it can be retried safely without duplication. Useful in scenarios with network issues or retries.
updated_timestamp (string, optional) The timestamp of the last update or creation of the custom attribute definition, in RFC 3339 format.

SquareupApi.DeleteMerchantCustomAttribute

Delete a custom attribute definition for a Square merchant.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to be deleted from the Square .

SquareupApi.GetMerchantCustomAttributeDefinition

Retrieves custom attribute definition for a Square seller .

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to retrieve. Use the qualified key if not the definition owner.
custom_attribute_version (integer, optional) Specifies the current version of the custom attribute definition for retrieving the most up-to-date data. If the specified version is higher than the current, a ‘BAD_REQUEST’ error is returned.

SquareupApi.UpdateMerchantCustomAttributeDefinition

Updates a merchant’s custom attribute definition.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to update. A string value that identifies the specific custom attribute definition.
creation_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format.
current_definition_version (integer, optional) Specify the current version of the custom attribute definition to ensure optimistic concurrency. Must match the latest version as stale versions are rejected.
custom_attribute_definition_identifier (string, optional) The identifier for the custom attribute definition. It may be a simple key or a qualified key formatted as application_id:simple_key with up to 60 alphanumeric characters, periods, underscores, and hyphens.
custom_attribute_definition_name (string, optional) The unique name for the custom attribute definition, required if the visibility is ‘VISIBILITY_READ_ONLY’ or ‘VISIBILITY_READ_WRITE_VALUES’.
custom_attribute_description (string, optional) A seller-oriented description for the custom attribute definition, detailing any constraints. Required for certain visibility settings.
custom_attribute_json_schema (json, optional) The JSON schema defining data type and structure for the custom attribute definition. Necessary when creating a definition.
custom_attribute_visibility (string, optional) The permission level required to view this custom attribute definition. Options: ‘VISIBILITY_HIDDEN’, ‘VISIBILITY_READ_ONLY’, ‘VISIBILITY_READ_WRITE_VALUES’.
idempotency_key (string, optional) A unique identifier for the request to ensure idempotency. It prevents duplicate processing.
last_updated_timestamp (string, optional) The timestamp of the last update to the custom attribute definition in RFC 3339 format.

SquareupApi.BulkDeleteMerchantCustomAttributes

Bulk delete custom attributes for a merchant.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.UpsertMerchantCustomAttributesBulk

Bulk creates or updates custom attributes for a merchant.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveMerchantInfo

Retrieve merchant details using their ID.

Parameters

merchant_id (string, required) The ID of the merchant to retrieve. Use ‘me’ to get the merchant accessible to this call.

SquareupApi.ListMerchantCustomAttributes

Retrieve custom attributes for a specified merchant.

Parameters

merchant_identifier (string, required) The unique identifier for the target merchant whose custom attributes are to be listed.
filter_custom_attribute_visibility (string, optional) Filters custom attribute definition results by visibility values. Valid options are ‘ALL’, ‘READ’, or ‘READ_WRITE’.
include_custom_attribute_definitions (boolean, optional) Set to true to include custom attribute definitions, providing details like name, description, and data type.
maximum_results_limit (integer, optional) The maximum number of results to return in a single response. Minimum is 1, maximum is 100, defaults to 20.
paging_cursor (string, optional) The cursor from the previous paged response to retrieve the next set of results.

SquareupApi.RemoveMerchantAttribute

Delete a custom attribute from a merchant.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to delete. Use the qualified key if the attribute is owned by another application.
merchant_id (string, required) The unique identifier of the merchant whose custom attribute is being deleted.

SquareupApi.RetrieveMerchantCustomAttribute

Retrieve a custom attribute associated with a merchant.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to retrieve, matching the key of a custom attribute definition in the Square seller .
merchant_identifier (string, required) The unique identifier of the target merchant to retrieve the custom attribute for.
custom_attribute_version (integer, optional) Integer value representing the custom attribute’s current version for consistent reads. If specified version exceeds current, an error is returned.
include_custom_attribute_definition (boolean, optional) Set to true to return the custom attribute definition, including name, description, and data type. Defaults to false.

SquareupApi.UpsertMerchantCustomAttribute

Create or update a custom attribute for a merchant.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
merchant_id (string, optional) The unique ID of the target merchant for whom the custom attribute is being created or updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
custom_attribute_key (string, optional) The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller . If the requester is not the definition owner, use the qualified key. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveLocationSettings

Retrieve settings for a Square-hosted checkout page location.

Parameters

location_id (string, required) The unique ID of the location for which to retrieve the checkout page settings.

SquareupApi.UpdateCheckoutLocationSettings

Update location settings for a Square-hosted checkout page.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
location_id (string, optional) The unique identifier of the location to update settings for the Square-hosted checkout page. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveSquareMerchantSettings

Retrieve Square merchant settings for checkout pages.

Parameters

This does not take any parameters.

SquareupApi.UpdateMerchantSettings

Updates Square-hosted checkout page settings for a merchant.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListPaymentLinks

Lists all online payment links for Squareup.

Parameters

pagination_cursor (string, optional) A pagination cursor from a previous call to fetch the next set of results. If not provided, returns the first page.
results_per_page_limit (integer, optional) Advisory limit on number of results per page. Ignored if negative, zero, or over 1000. Defaults to 100.

SquareupApi.CreatePaymentLink

Create a Square-hosted checkout page for payments.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.DeletePaymentLink

Deletes a specified payment link.

Parameters

payment_link_id (string, required) The unique identifier of the payment link to delete. This ID specifies which payment link should be removed.

SquareupApi.RetrievePaymentLink

Retrieve a payment link using its ID.

Parameters

payment_link_id (string, required) The unique ID of the payment link to retrieve.

SquareupApi.UpdatePaymentLink

Update details of an existing payment link.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
payment_link_id (string, optional) The unique identifier of the payment link to update. Required to specify which link will be modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CreateOrderForPurchase

Creates a new order for purchase with product details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveMultipleOrders

Retrieve multiple orders using their IDs.

Parameters

order_ids_list (array[string], required) An array of order IDs to retrieve, with a maximum of 100 per request.
location_id (string, optional) Optional location ID for the orders. Omit to use the current merchant’s ID.

SquareupApi.PreviewOrderPricing

Preview order pricing without creating an order.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CloneOrderDraft

Clone an existing order as a draft.

Parameters

order_id_to_clone (string, required) The ID of the order you want to clone.
clone_request_idempotency_key (string, optional) A unique string to identify the clone request. Allows safe retries without duplicating cloned orders.
order_version (integer, optional) An optional integer specifying the order version for concurrency protection. If omitted, the latest version is used.

SquareupApi.ListOrderCustomAttributeDefinitions

Retrieve order-related custom attribute definitions for a Square seller.

Parameters

custom_attribute_visibility_filter (string, optional) Specify whether to return all custom attributes, or only those that are read-only (‘READ’) or read-write (‘READ_WRITE’). Valid options are ‘ALL’, ‘READ’, or ‘READ_WRITE’.
maximum_results_per_page (integer, optional) The maximum number of results to return in a single response. Accepts values 1 to 100, default is 20.
pagination_cursor (string, optional) The cursor for fetching the next page of results in a multi-page response. It should be used as returned from a previous call.

SquareupApi.CreateOrderCustomAttribute

Define a custom attribute for Square orders.

Parameters

creation_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format.
current_version_of_custom_attribute_definition (integer, optional) Read-only. Specifies the current version of the custom attribute definition for optimistic concurrency and consistency.
custom_attribute_definition_key (string, optional) A unique identifier for the custom attribute definition. Can be a simple or qualified key. Must be unique per application, seller, and resource type. Cannot exceed 60 characters.
custom_attribute_definition_name (string, optional) The name for the custom attribute definition, unique within the seller and application. Required if visibility is read-only or read-write.
custom_attribute_description (string, optional) Provide a detailed seller-oriented description for the custom attribute definition. Required if visibility is ‘READ_ONLY’ or ‘READ_WRITE_VALUES’.
custom_attribute_schema (json, optional) The JSON schema defining the data type of the custom attribute. Required when creating a definition.
custom_attribute_visibility (string, optional) Specifies who can read and write the custom attribute values. Options are: ‘VISIBILITY_HIDDEN’, ‘VISIBILITY_READ_ONLY’, ‘VISIBILITY_READ_WRITE_VALUES’.
unique_request_id (string, optional) A unique identifier for this request to ensure idempotency. Use a UUID or similar unique string.
updated_timestamp (string, optional) The timestamp in RFC 3339 format indicating when the custom attribute definition was last updated or created.

SquareupApi.DeleteOrderCustomAttributeDefinition

Delete a custom attribute definition from an order.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition to delete from an order.

SquareupApi.RetrieveOrderCustomAttributeDefinition

Retrieve a custom attribute definition for an order.

Parameters

custom_attribute_key (string, required) The key of the custom attribute definition you want to retrieve. This should match the key set in Square seller .
current_custom_attribute_version (integer, optional) Specify the current version of the custom attribute for optimistic concurrency control.

SquareupApi.UpdateOrderCustomAttributeDefinition

Modify order-related custom attribute definitions.

Parameters

custom_attribute_key (string, required) The key for the custom attribute definition to update. Must be unique per application, seller, and resource type.
creation_timestamp (string, optional) The timestamp indicating when the custom attribute definition was created, in RFC 3339 format. This field is read-only and used for informational purposes.
current_version_of_custom_attribute_definition (integer, optional) The current version of the custom attribute definition. Provide this to enable optimistic concurrency.
custom_attribute_definition_key (string, optional) The identifier of the custom attribute definition. Can be a simple or qualified key. Must be unique per application, seller, and resource type.
custom_attribute_description (string, optional) Description for the custom attribute definition, viewable as a Square UI tooltip. Required if visibility is READ_ONLY or READ_WRITE_VALUES.
custom_attribute_name (string, optional) The unique name for the custom attribute definition within the seller and application pair. Required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
custom_attribute_schema (json, optional) Provide the JSON schema for the custom attribute definition, determining the data type of associated attributes. This is mandatory when creating a definition.
custom_attribute_updated_timestamp (string, optional) The timestamp in RFC 3339 format showing when the custom attribute definition was created or last updated.
custom_attribute_visibility (string, optional) Sets the visibility level for the custom attribute definition. Options: ‘VISIBILITY_HIDDEN’, ‘VISIBILITY_READ_ONLY’, ‘VISIBILITY_READ_WRITE_VALUES’.
idempotency_identifier (string, optional) A unique string identifier for the request to ensure idempotency. Refer to Square’s idempotency guidelines for more details.

SquareupApi.BulkDeleteOrderCustomAttributes

Perform bulk deletion of custom attributes from orders.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkUpsertOrderCustomAttributes

Perform bulk create or update of order custom attributes.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchSquareOrders

Search and retrieve orders from Square locations.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveOrderById

Retrieve an order’s details using its ID.

Parameters

order_id (string, required) The unique identifier of the order to retrieve from the Square API.

SquareupApi.UpdateOrderSquare

Update fields of an open Square order.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
order_id (string, optional) The unique identifier for the order that needs to be updated. This ID specifies which order will have its fields modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListOrderCustomAttributes

Retrieve custom attributes associated with an order.

Parameters

target_order_id (string, required) The unique identifier of the target order to retrieve custom attributes for.
custom_attributes_visibility (string, optional) Specify which custom attributes to return: ‘ALL’, ‘READ’, or ‘READ_WRITE’.
include_custom_attribute_definitions (boolean, optional) Set to true to include custom attribute definition details such as name, description, and data type. Defaults to false.
max_results_per_page (integer, optional) Specifies the maximum number of custom attribute results returned per page. Accepts values from 1 to 100, default is 20.
pagination_cursor (string, optional) The cursor used to retrieve the next page of results in a paginated response.

SquareupApi.DeleteOrderCustomAttribute

Delete a custom attribute from an order profile.

Parameters

custom_attribute_key (string, required) The key of the custom attribute to delete. Must match an existing custom attribute definition key.
order_id (string, required) The unique identifier of the order from which the custom attribute will be deleted.

SquareupApi.RetrieveOrderCustomAttribute

Retrieve a custom attribute for a specified order.

Parameters

custom_attribute_key (string, required) The key for the custom attribute to retrieve, matching an existing attribute definition key.
order_id (string, required) The unique ID of the target order to retrieve the custom attribute for.
custom_attribute_version (integer, optional) Specify the current version of the custom attribute for optimistic concurrency control.
include_custom_attribute_definition (boolean, optional) Set to true to include custom attribute definition details such as name, description, and data type. Defaults to false.

SquareupApi.UpdateOrderCustomAttribute

Create or update a custom attribute for an order.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
order_id (string, optional) The ID of the target order for which the custom attribute is being created or updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
custom_attribute_key (string, optional) The key of the custom attribute to be created or updated. Must match an existing custom attribute definition key. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.PayOrder

Settle an order using approved payments.

Parameters

order_id (string, required) The unique identifier of the order to be paid.
unique_transaction_identifier (string, required) A unique string to identify the request and ensure the prevention of duplicate payments. Reuse the same key for retrying the same request.
order_version (integer, optional) Specify the version of the order to be paid. Defaults to latest if not provided.
payment_ids_to_collect (array[string], optional) Array of payment IDs to collect; total must match the order total.

SquareupApi.RetrievePaymentsList

Retrieve a list of payments from your .

Parameters

card_last_four_digits (string, optional) Filter payments by the last four digits of the payment card used.
end_time (string, optional) End of the time range for retrieving payments, in RFC 3339 format. Defaults to the current time.
end_time_updated_for_payments (string, optional) The end time for retrieving payments, in RFC 3339 format, based on updated_at.
is_offline_payment (boolean, optional) Set to true to include offline payments, or false to exclude them.
max_results_per_page (integer, optional) The maximum number of payment results to return per page (up to 100). Defaults to 100 if more is specified.
offline_end_time (string, optional) The end time in RFC 3339 format for retrieving offline payments, based on the offline_payment_details.client_created_at field. Default is the current time.
offline_payment_start_time (string, optional) Start of the time range for retrieving offline payments in RFC 3339 format. Uses ‘offline_payment_details.client_created_at’.
pagination_cursor (string, optional) A pagination cursor for fetching the next set of payment results from the ListPayments endpoint.
payment_card_brand (string, optional) The brand of the payment card to filter payments (e.g., VISA, MasterCard).
results_sort_order (string, optional) Specify the order of the results: ASC for oldest to newest, DESC for newest to oldest (default).
sort_by_field (string, optional) Choose the field to sort results by. Options: CREATED_AT, OFFLINE_CREATED_AT, UPDATED_AT. Default is CREATED_AT.
specific_location_id (string, optional) Limit results to the specified location ID. Defaults to the main location associated with the seller.
start_time_range (string, optional) Start time to retrieve payments, in RFC 3339 format. Defaults to one year ago if not specified.
total_payment_amount (integer, optional) The exact amount in the total_money field for a payment. Use an integer to specify the amount in cents.
updated_at_start_time (string, optional) Start of the time range for retrieving payments based on the updated_at field, in RFC 3339 format.

SquareupApi.CreatePayment

Create a payment using credit/debit card or other sources.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CancelPaymentByIdempotency

Cancel a payment by idempotency key when status is unknown.

Parameters

payment_idempotency_key (string, required) The idempotency key used to identify the payment to cancel. It should match the key used in the original CreatePayment request.

SquareupApi.GetPaymentDetails

Retrieve detailed information about a specific payment.

Parameters

payment_id (string, required) Unique ID to retrieve specific payment details.

SquareupApi.UpdatePaymentStatus

Update a payment’s approved status and details.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
payment_identifier (string, optional) The unique ID of the payment you want to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CancelPayment

Cancel or void an approved payment.

Parameters

payment_id_to_cancel (string, required) The unique identifier of the payment to be canceled. Must have an APPROVED status.

SquareupApi.CompletePayment

Complete an approved payment using Squareup.

Parameters

payment_identifier (string, required) The unique ID identifying the payment to be completed. This is required for completing a payment with an ‘APPROVED’ status.
current_payment_version_token (string, optional) The token identifying the current Payment version for optimistic concurrency. It ensures the Payment version matches the caller’s expectations to prevent mismatches.

SquareupApi.ListPayouts

Retrieve a list of payouts for the default location.

Parameters

begin_timestamp (string, optional) The starting timestamp for the payout creation time, in RFC 3339 format. Defaults to one year ago if not provided.
end_time_rfc3339 (string, optional) RFC 3339 timestamp marking the end of the payout creation time. Defaults to current time if not specified.
filter_payout_status (string, optional) If provided, only payouts with the specified status (‘SENT’, ‘FAILED’, ‘PAID’) are returned.
location_identifier (string, optional) The ID of the location for which to list the payouts. Defaults to the main location associated with the seller if not specified.
pagination_cursor (string, optional) A cursor for pagination, returned by a previous call. Use it to retrieve the next set of results. Be aware of changes in request parameters between calls.
payout_sort_order (string, optional) Specifies the order for listing payouts. Use ‘DESC’ for descending or ‘ASC’ for ascending order.
results_per_page (integer, optional) Maximum number of results per page. Defaults to 100 and cannot exceed 100.

SquareupApi.GetPayoutDetails

Retrieve details of a specific payout using payout ID.

Parameters

payout_id (string, required) The unique identifier of the payout to retrieve details for. This ID is required to fetch the specific payout information.

SquareupApi.ListPayoutEntries

Retrieve all payout entries for a specific payout.

Parameters

payout_id (string, required) The unique string identifier for the specific payout to retrieve information for.
maximum_results_per_page (integer, optional) Specifies the maximum number of results to return on a single page (max 100). Default is 100.
pagination_cursor (string, optional) A cursor to retrieve the next set of results in a paginated response. Use a cursor from a previous response for continuity.
payout_entries_sort_order (string, optional) Specify the order (ASC or DESC) in which payout entries are listed.

SquareupApi.ListPaymentRefunds

Retrieve a list of payment refunds for the .

Parameters

end_time_rfc3339 (string, optional) Specifies the end time in RFC 3339 format to retrieve PaymentRefunds based on created_at. Defaults to the current time.
limit_results_to_location_id (string, optional) Limit results to refunds from the specified location. By default, returns all locations.
maximum_results_per_page (integer, optional) Specifies the max number of refund results per page. Max value is 100; defaults to 100.
pagination_cursor (string, optional) A pagination cursor from a previous response to fetch the next set of results.
refund_status_filter (string, optional) Specify a refund status to filter the results. If omitted, refunds of all statuses are returned.
refunds_start_time (string, optional) The start time in RFC 3339 format to retrieve PaymentRefunds based on the created_at field. Default is the current time minus one year.
results_sort_order (string, optional) The order in which results are listed by their creation date: ASC for oldest to newest, DESC for newest to oldest (default).
sort_results_by_field (string, optional) The field used to sort payment refund results. Options: ‘CREATED_AT’ (default) or ‘UPDATED_AT’.
source_payment_type (string, optional) Specify to only return refunds for payments with the indicated source type (e.g., CARD, BANK_ACCOUNT).
updated_at_end_time (string, optional) The end of the time range for retrieving refunds, in RFC 3339 format. Default is the current time.
updated_at_start_time (string, optional) Start of time range for retrieving each PaymentRefund, in RFC 3339 format. Defaults to begin_time if omitted.

SquareupApi.RefundPayment

Refund a payment partially or fully using Square.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveRefundDetails

Retrieve details of a specific refund using the refund ID.

Parameters

refund_unique_id (string, required) The unique ID for the specific refund to retrieve details for.

SquareupApi.ListSquareOnlineSites

List all Square Online sites for a seller.

Parameters

This does not take any parameters.

SquareupApi.DeleteSquareSnippet

Delete a snippet from a Square Online site.

Parameters

site_id (string, required) The ID of the Square Online site containing the snippet to be deleted.

SquareupApi.RetrieveOnlineSiteSnippet

Retrieve a specific snippet from a Square Online site.

Parameters

site_identifier (string, required) The unique ID of the Square Online site containing the snippet to retrieve.

SquareupApi.AddOrUpdateSquareOnlineSnippet

Add or update a snippet on a Square Online site.

Parameters

site_id_for_snippet (string, required) The ID of the site where you want to add or update the snippet. Obtained through ListSites function.
snippet_code_content (string, required) The code snippet to add or update, which can include valid HTML, JavaScript, or both. This will be appended to the head element of all site pages except checkout pages.
snippet_id (string, optional) The Square-assigned ID for the snippet to add or update.
snippet_initial_creation_timestamp (string, optional) The timestamp indicating when the snippet was initially added to the site, in RFC 3339 format.
snippet_last_updated_timestamp (string, optional) The timestamp for when the snippet was last updated on the site, in RFC 3339 format.
snippet_site_id (string, optional) The ID of the site that contains the snippet to be updated or added.

SquareupApi.CreateCustomerSubscription

Enroll a customer in a subscription plan.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkSwapSubscriptionPlan

Schedule a plan variation swap for multiple subscriptions.

Parameters

location_id_association (string, required) The ID of the location to associate with the swapped subscriptions. This specifies where the subscription changes are applied.
new_plan_variation_id (string, required) The ID of the new subscription plan variation for the swap. This field is required.
old_plan_variation_id (string, required) The ID of the current plan variation to swap. Active subscriptions using this plan will switch to the new variation on their next billing day.

SquareupApi.SearchSubscriptions

Search for subscriptions by location and customer IDs.

Parameters

customer_ids_to_filter (array[string], optional) A list of customer IDs to filter subscriptions by. Leave empty to include all customers.
filter_by_location_ids (array[string], optional) An array of location IDs to filter subscriptions by location.
filter_by_source_applications (array[string], optional) A list of source application names to filter subscriptions by.
include_related_info (array[string], optional) Specify related information to include in the response, such as ‘actions’ for scheduled actions on subscriptions.
max_subscriptions_returned (integer, optional) Defines the maximum number of subscriptions to return in a single response.
pagination_cursor (string, optional) Cursor for fetching the next set of subscription results if previous results exceeded the limit. If not set, returns the last page of results.

SquareupApi.RetrieveSubscriptionDetails

Retrieve details of a specific subscription using its ID.

Parameters

subscription_id (string, required) The unique ID of the subscription to retrieve details for. Necessary to specify which subscription to access.
include_related_info (string, optional) Specify related info to include in the response. Use ‘actions’ to include scheduled actions on the subscription.

SquareupApi.UpdateSubscription

Update subscription details with new or cleared values.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
subscription_id (string, optional) The unique identifier of the subscription you want to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.DeleteSubscriptionAction

Delete a scheduled action for a subscription.

Parameters

subscription_id (string, required) The ID of the subscription for which the action is to be deleted. Provide the correct subscription ID to ensure accurate targeting.
targeted_action_id (string, required) The ID of the specific action to be deleted from the subscription.

SquareupApi.ChangeBillingAnchorDate

Change the billing anchor date for a subscription.

Parameters

subscription_id (string, required) The ID of the subscription for which the billing anchor date will be updated.
billing_anchor_day (integer, optional) The day (1-31) of the month to set as the billing anchor for the cycle.
scheduled_billing_anchor_change_date (string, optional) The YYYY-MM-DD-formatted date when the BILLING_ANCHOR_CHANGE action occurs. If unspecified or within current billing cycle, change is immediate.

SquareupApi.CancelSubscription

Cancel an active subscription at the end of the billing period.

Parameters

subscription_id (string, required) The unique ID of the subscription to be canceled. Required for scheduling the cancellation action.

SquareupApi.ListSubscriptionEvents

Retrieve all events for a specific subscription.

Parameters

subscription_id (string, required) The unique identifier for the subscription whose events are to be retrieved.
event_limit (integer, optional) The maximum number of subscription events to retrieve in the response.
pagination_cursor (string, optional) Specify the cursor from a previous response to fetch the next page of subscription events. Leave unset to get the last page.

SquareupApi.PauseSubscription

Schedule a pause for an active subscription.

Parameters

subscription_id (string, required) The unique ID of the subscription you want to pause.
pause_cycle_count (integer, optional) Specify the number of billing cycles to pause the subscription. A ‘RESUME’ action will be scheduled at the end of this period. Do not set ‘resume_effective_date’ or ‘resume_change_timing’ if this is used.
pause_effective_date (string, optional) The YYYY-MM-DD-formatted date when the scheduled PAUSE action occurs. If unspecified or within the current billing cycle, the subscription pauses at the start of the next cycle.
pause_reason (string, optional) The reason provided by the for pausing the subscription. It should convey the rationale behind the pause action.
reactivation_date (string, optional) The date (YYYY-MM-DD) when the subscription is reactivated by a scheduled RESUME action. Must be at least one billing cycle after pause_effective_date.
resume_change_timing (string, optional) Specifies when the subscription resume action takes place. Options are ‘IMMEDIATE’ or ‘END_OF_BILLING_CYCLE’.

SquareupApi.ResumeSubscription

Resume a paused or deactivated subscription.

Parameters

subscription_id (string, required) The ID of the subscription to resume. Provide a valid subscription ID string.
resume_change_timing (string, optional) Specify when the pending change to resume the subscription takes effect. Choose between ‘IMMEDIATE’ or ‘END_OF_BILLING_CYCLE’.
subscription_resume_effective_date (string, optional) The YYYY-MM-DD-formatted date when the subscription is reactivated.

SquareupApi.SwapSubscriptionPlan

Swap a subscription plan variation for an existing subscription.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
subscription_id (string, optional) The ID of the subscription to swap the plan for. This is required to identify which subscription will have its plan changed. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CreateTeamMember

Create a new team member with given and family names.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkCreateTeamMembers

Create multiple team members in bulk.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.BulkUpdateTeamMembers

Update multiple team members in bulk.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListJobs

Retrieve jobs from a seller’s , sorted by title.

Parameters

pagination_cursor (string, optional) The pagination cursor for retrieving the next page of results. Use the cursor from the previous call to continue fetching.

SquareupApi.CreateJobInSellerAccount

Create a job for a seller .

Parameters

unique_creation_request_id (string, required) A unique string to identify the CreateJob request, ensuring it is not processed multiple times.
is_tip_eligible (boolean, optional) Indicates whether team members can earn tips for the job. Accepts a boolean value.
job_creation_timestamp (string, optional) The timestamp for when the job was created, in RFC 3339 format.
job_id (string, optional) Unique Square-assigned job ID. This is read-only and used internally by Square.
job_last_updated_timestamp (string, optional) The timestamp indicating when the job was last updated, in RFC 3339 format.
job_title (string, optional) The title of the job to be created in the seller’s .
job_version_readonly (integer, optional) Read-only field for the current version of the job, used for optimistic concurrency in UpdateJob requests.

SquareupApi.RetrieveJobDetails

Retrieve details of a specified job.

Parameters

job_identifier (string, required) The unique string ID of the job to retrieve details for.

SquareupApi.UpdateJobDetails

Update job title or tip eligibility in the system.

Parameters

job_id_to_update (string, required) The unique ID of the job to update. This specifies which job’s title or tip eligibility you want to modify.
enable_tips_for_job (boolean, optional) Set to true to allow team members to earn tips for the job, false to prevent them.
job_creation_timestamp (string, optional) The timestamp representing when the job was created, formatted in RFC 3339.
job_id (string, optional) The unique Square-assigned ID of the job. Obtainable via ListJobs API or from team member wage settings.
job_last_updated_timestamp (string, optional) The timestamp when the job was last updated, in RFC 3339 format. Used for optimistic concurrency control.
job_title (string, optional) The new title of the job to update.
job_version_for_concurrency (integer, optional) The current version of the job for optimistic concurrency control. Must match the server version to proceed with updates.

SquareupApi.SearchTeamMembers

Retrieve a filtered list of team members for a business.

Parameters

filter_by_location_ids (array[string], optional) Filter team members by specified location IDs. If empty, includes all locations.
maximum_team_members_per_page (integer, optional) Specify the maximum number of team members to return per page, default is 100.
pagination_cursor (string, optional) The cursor used to retrieve the next page of results in a paginated list.
return_account_owner_only (boolean, optional) Set to true to return only the team member who is the Square owner.
team_member_status (string, optional) Filter team members by their status: ‘ACTIVE’ or ‘INACTIVE’.

SquareupApi.GetTeamMemberDetails

Retrieve details for a specific team member by ID.

Parameters

team_member_id (string, required) The unique identifier for the team member to retrieve their details from Squareup.

SquareupApi.UpdateTeamMember

Updates a single TeamMember object.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
team_member_id (string, optional) The unique identifier of the team member to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveTeamMemberWageSetting

Retrieve wage settings for a specified team member.

Parameters

team_member_id (string, required) The unique identifier for the team member whose wage setting needs to be retrieved.

SquareupApi.UpdateWageSetting

Create or update a team member’s wage setting.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
team_member_id (string, optional) The unique ID of the team member whose WageSetting will be updated or created. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CreateTerminalAction

Create and send a terminal action request to a device.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchTerminalActions

Retrieve a filtered list of terminal action requests.

Parameters

device_id_filter (string, optional) Filter TerminalActions by a specific device ID. Leave blank to include all devices.
end_time_rfc3339 (string, optional) A datetime in RFC 3339 format indicating the end of the time range.
filter_terminal_action_status (string, optional) Filter results by the status of the TerminalAction (e.g., PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED).
pagination_cursor (string, optional) A pagination cursor from a previous response to retrieve the next set of results.
result_limit (integer, optional) Limit the number of results returned for a single request.
result_sort_order (string, optional) Defines the order (‘DESC’ or ‘ASC’) for sorting the terminal action requests.
start_time_rfc3339 (string, optional) The start datetime in RFC 3339 format for filtering terminal actions.
terminal_action_type (string, optional) Specify the type of terminal action, such as ‘QR_CODE’, ‘PING’, etc. This helps filter actions by their purpose.

SquareupApi.RetrieveTerminalAction

Retrieve a Terminal action request by action ID.

Parameters

terminal_action_id (string, required) Unique ID for the desired Terminal Action. This is required to retrieve the specific action request.

SquareupApi.CancelTerminalAction

Cancel a terminal action request if possible.

Parameters

terminal_action_id (string, required) Unique ID for the TerminalAction you want to cancel. This ID helps target the specific action to abort.

SquareupApi.DismissTerminalAction

Dismiss a Terminal action request if permitted.

Parameters

terminal_action_id (string, required) Unique ID for the TerminalAction to be dismissed.

SquareupApi.CreateTerminalCheckout

Create a Terminal checkout request for payment.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchTerminalCheckouts

Retrieve filtered Terminal checkout requests for the merchant.

Parameters

checkout_status_filter (string, optional) Specify the desired status to filter TerminalCheckout results. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED.
device_id_filter (string, optional) Filters TerminalCheckout objects associated with a specific device. Omitting this shows checkouts for all devices.
end_time_rfc3339 (string, optional) A datetime in RFC 3339 format indicating when the time range ends.
pagination_cursor (string, optional) A pagination cursor from a previous call, used to fetch the next set of results for the same query. Useful for traversing paginated results.
result_limit (integer, optional) Maximum number of results to return in a single request.
result_sort_order (string, optional) Specifies the order (DESC or ASC) for results in a request, such as chronological or alphabetical.
start_time_range (string, optional) The start datetime for the TerminalCheckout search in RFC 3339 format.

SquareupApi.RetrieveTerminalCheckout

Retrieve a Terminal checkout request by checkout ID.

Parameters

checkout_id (string, required) The unique ID for the desired TerminalCheckout request. Use this ID to retrieve specific checkout details.

SquareupApi.CancelTerminalCheckout

Cancel a terminal checkout request if possible.

Parameters

terminal_checkout_id (string, required) The unique ID for the desired TerminalCheckout to be canceled.

SquareupApi.DismissTerminalCheckout

Dismiss a Terminal checkout request.

Parameters

terminal_checkout_id (string, required) Unique ID for the TerminalCheckout to be dismissed.

SquareupApi.CreateTerminalRefund

Creates a refund request for Interac payments on Square Terminal.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchTerminalRefunds

Retrieve a filtered list of Interac Terminal refund requests.

Parameters

device_id_filter (string, optional) TerminalRefund objects associated with a specific device. If not provided, all refunds for the are displayed.
end_time_range (string, optional) A datetime value in RFC 3339 format indicating the end of the time range for filtering terminal refund requests.
filter_terminal_refund_status (string, optional) Filter terminal refunds by status. Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, or COMPLETED.
pagination_cursor (string, optional) A cursor to paginate results, used to retrieve the next set from a previous query.
result_limit (integer, optional) Specifies the maximum number of refund results to retrieve in a single request.
sort_order (string, optional) The order in which terminal refund results are listed. Use ‘ASC’ for oldest to newest or ‘DESC’ for newest to oldest (default).
start_datetime (string, optional) A datetime in RFC 3339 format. Indicates when the time range starts for filtering terminal refunds.

SquareupApi.GetTerminalRefund

Retrieve details of an Interac Terminal refund by ID.

Parameters

terminal_refund_id (string, required) The unique ID for the desired TerminalRefund. Use this ID to retrieve specific refund details available for 30 days.

SquareupApi.CancelTerminalRefund

Cancel a terminal refund request by its ID.

Parameters

refund_request_id (string, required) The unique ID of the terminal refund request to cancel.

SquareupApi.DismissTerminalRefund

Dismiss a Terminal refund request.

Parameters

terminal_refund_unique_id (string, required) Unique ID for the TerminalRefund associated with the refund to be dismissed.

SquareupApi.CreateTransferOrder

Create a draft transfer order between locations.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchTransferOrders

Search for transfer orders using specific filters.

Parameters

destination_location_ids (array[string], optional) Array of destination location IDs to filter transfer orders.
filter_by_order_statuses (array[string], optional) Filter transfer orders by their statuses. Accepts an array of status strings. Refer to TransferOrderStatus for valid values.
maximum_results (integer, optional) Specify the maximum number of results to return, from 1 to 100.
pagination_cursor (string, optional) A string token to continue a search from a previous position, enabling pagination through results.
sort_by_field (string, optional) Specify the field to sort transfer orders. Options: CREATED_AT, UPDATED_AT.
sort_order (string, optional) Specify the order (‘DESC’ or ‘ASC’) in which results are returned. ‘DESC’ for descending and ‘ASC’ for ascending.
source_location_ids (array[string], optional) Array of source location IDs to filter transfer orders by their source location.

SquareupApi.DeleteDraftTransferOrder

Delete a draft transfer order and trigger webhook event.

Parameters

transfer_order_id (string, required) The ID of the transfer order in DRAFT status to delete. Only draft orders are eligible.
optimistic_concurrency_version (integer, optional) Version number used for optimistic concurrency control to ensure data consistency when deleting a draft transfer order.

SquareupApi.RetrieveTransferOrderDetails

Retrieve detailed information of a specific transfer order.

Parameters

transfer_order_id (string, required) The ID of the transfer order to retrieve, required to get order details.

SquareupApi.UpdateTransferOrder

Update specific fields of a transfer order.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
transfer_order_identifier (string, optional) The unique identifier of the transfer order to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CancelTransferOrder

Cancel a transfer order in progress for inventory locations.

Parameters

transfer_order_id (string, required) The ID of the transfer order to cancel. The order must be in STARTED or PARTIALLY_RECEIVED status.
unique_request_key (string, required) A unique string to identify this request. Must be unique for each UpdateTransferOrder request.
transfer_order_version (integer, optional) Provide the version number for optimistic concurrency when canceling the transfer order.

SquareupApi.RecordTransferOrderReceipt

Record received items for a transfer order.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
transfer_order_id (string, optional) The ID of the transfer order for which items are being received. This ID is required to process the receipt of items, including partial and damaged quantities, and update inventory accordingly. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.StartTransferOrder

Start a transfer order to mark it as in-transit.

Parameters

transfer_order_id (string, required) The ID of the transfer order to start. Must be in DRAFT status.
unique_request_identifier (string, required) A unique string to identify each UpdateTransferOrder request, ensuring it is not repeated for any request.
optimistic_concurrency_version (integer, optional) Specify the version number for optimistic concurrency control. Ensure the version is current to avoid conflicts.

SquareupApi.BulkCreateVendors

Create multiple vendor profiles for suppliers.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.RetrieveVendors

Retrieve detailed information about specific vendors.

Parameters

vendor_ids (array[string], optional) List of vendor IDs to retrieve details for. Provide the IDs as an array of strings.

SquareupApi.BulkUpdateVendors

Update multiple vendor records simultaneously.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.CreateVendor

Create a vendor for a supplier to a seller.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.SearchVendors

Search for vendors using filters and sorters.

Parameters

pagination_cursor (string, optional) A string used to retrieve the next set of results for a previous query. Follow the pagination guide for details.
sort_field_for_vendors (string, optional) Specify the vendor property field to sort the results by. Options include ‘NAME’ or ‘CREATED_AT’.
sort_order (string, optional) Specify the order (e.g., chronological or alphabetical) for sorting the results. Options are ‘ASC’ or ‘DESC’.
vendor_names_to_filter (array[string], optional) Array of vendor names to filter the search results by. Only vendors matching these names will be retrieved.
vendor_statuses (array[string], optional) List of vendor statuses to filter the search results. Refer to possible values in VendorStatus.

SquareupApi.RetrieveVendorDetails

Retrieve detailed information about a vendor by ID.

Parameters

vendor_id (string, required) The unique ID of the vendor to retrieve details for.

SquareupApi.UpdateVendorInfo

Update an existing vendor’s information.

Parameters

mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

SquareupApi.ListWebhookEventTypes

Retrieve all webhook event types available for subscription.

Parameters

api_version_for_event_types (string, optional) Specify the API version to list event types, overriding the default version.

SquareupApi.ListWebhookSubscriptions

Lists all webhook subscriptions owned by the application.

Parameters

include_disabled_subscriptions (boolean, optional) If set to true, includes disabled subscriptions in the results. By default, only enabled subscriptions are returned.
maximum_results_per_page (integer, optional) The maximum number of results returned in one page, up to 100.
pagination_cursor (string, optional) A cursor from a previous call for paginating results. Use it to retrieve the next set of results.
sort_order (string, optional) Sort returned list by subscription creation date. Options are ‘ASC’ for ascending or ‘DESC’ for descending. Defaults to ‘ASC’.

SquareupApi.CreateWebhookSubscription

Creates a webhook subscription.

Parameters

api_version (string, optional) Specifies the API version for the webhook subscription. Optional; defaults to the application’s current API version if not provided.
enable_subscription (boolean, optional) Indicates whether the subscription is enabled (true) or not (false).
event_types (array[string], optional) An array of event types for the subscription, each as a string.
subscription_created_at (string, optional) The creation timestamp of the subscription in RFC 3339 format, e.g., “2016-09-04T23:59:33.123Z”.
subscription_last_updated_timestamp (string, optional) The timestamp of when the subscription was last updated, in RFC 3339 format (e.g., ‘2016-09-04T23:59:33.123Z’).
subscription_name (string, optional) The name for the webhook subscription.
subscription_signature_key (string, optional) The Square-generated signature key used to validate the origin of the webhook event.
subscription_unique_id (string, optional) A Square-generated unique ID for the webhook subscription.
unique_request_identifier (string, optional) A unique string to ensure the idempotence of the CreateWebhookSubscription request, preventing duplicate entries.
webhook_notification_url (string, optional) The URL where webhook notifications will be sent. Ensure it is accessible and accurately formatted.

SquareupApi.DeleteWebhookSubscription

Deletes a specified webhook subscription.

Parameters

webhook_subscription_id (string, required) The ID of the webhook subscription to delete. This ID is required to specify which subscription needs to be removed.

SquareupApi.RetrieveWebhookSubscription

Retrieve details of a specific webhook subscription.

Parameters

webhook_subscription_id (string, required) The unique ID of the webhook subscription to retrieve.

SquareupApi.UpdateWebhookSubscription

Update a webhook subscription to modify its settings.

Parameters

subscription_id (string, required) The unique ID of the subscription to update. This is required to identify the webhook subscription that needs to be modified.
api_version_of_subscription (string, optional) Specify the API version for the subscription. Optional for creation and defaults to the application’s API version if not provided.
event_types (array[string], optional) An array of event types associated with this subscription that trigger the webhook.
signature_key (string, optional) The Square-generated signature key for validating the webhook origin.
subscription_created_timestamp (string, optional) The timestamp indicating when the subscription was created, formatted in RFC 3339.
subscription_enabled (boolean, optional) Set to true to enable the subscription or false to disable it.
subscription_name (string, optional) The new name for the webhook subscription to update.
subscription_unique_id (string, optional) A Square-generated unique ID for the webhook subscription to be updated. This is required to identify which subscription to modify.
updated_at_timestamp (string, optional) The timestamp of the last update for the subscription, in RFC 3339 format (e.g., “2016-09-04T23:59:33.123Z”).
webhook_notification_url (string, optional) The URL to which webhooks are sent. Must be a valid URL that can receive POST requests.

SquareupApi.UpdateWebhookSignatureKey

Update a webhook subscription’s signature key.

Parameters

webhook_subscription_id (string, required) The ID of the Webhook Subscription to update. This is a required field.
unique_request_identifier (string, optional) A unique string to identify the UpdateWebhookSubscriptionSignatureKey request, ensuring idempotency.

SquareupApi.TestWebhookSubscription

Send a test event to a webhook subscription URL.

Parameters

webhook_subscription_id (string, required) The ID of the Webhook Subscription to test. This is required for sending a test event.
test_event_type (string, optional) Specifies the event type for testing the webhook subscription. It must match an event type in the subscription’s event list.

Reference

Below is a reference of enumerations used by some of the tools in the SquareupApi Server:

ToolMode

GET_REQUEST_SCHEMA: get_request_schema
EXECUTE: execute

Auth

The Arcade Square Server uses the Square auth provider to connect to users’ Square .

With the Arcade Cloud Platform, there’s nothing to configure. Your will see Arcade as the name of the application that’s requesting permission.

With a self-hosted installation of Arcade, you need to configure the Square auth provider with your own Square app credentials.

Get Building

Use tools hosted on Arcade Cloud

Arcade tools are hosted by our cloud platform and ready to be used in your agents. Learn how.

Self Host Arcade tools

Arcade tools can be self-hosted on your own infrastructure. Learn more about self-hosting.

pip install arcade_squareup_api

Last updated on October 29, 2025

Sharepoint TicktickApi