Square
Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
Endpoints 332
OAuth
- POSTRevokeToken
/oauth2/revokeRevokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of… - POSTObtainToken
/oauth2/tokenReturns an OAuth access token and refresh token using the authorization_code or refresh_token grant type. When grant_type is authorization_code: With the code… - POSTRetrieveTokenStatus
/oauth2/token/statusReturns information about an OAuth access token or an application’s personal access token. Add the access token to the Authorization header of the request.…
V1Transactions
- GETV1ListOrders
/v1/:location_id/orders?order=DESC&limit=0&batch_token=stringDeprecated. Provides summary information for a merchant's online store orders. - GETV1RetrieveOrder
/v1/:location_id/orders/:order_idDeprecated. Provides comprehensive information for a single online store order, including the order's history. - PUTV1UpdateOrder
/v1/:location_id/orders/:order_idDeprecated. Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
ApplePay
- POSTRegisterDomain
/v2/apple-pay/domainsActivates a domain for use with Apple Pay on the Web and Square. A validation is performed on this domain by Apple to ensure that it is properly set up as an…
BankAccounts
- GETListBankAccounts
/v2/bank-accounts?cursor=string&limit=0&location_id=string&customer_id=stringReturns a list of BankAccount objects linked to a Square account. - POSTCreateBankAccount
/v2/bank-accountsStore a bank account on file for a square account - GETGetBankAccountByV1Id
/v2/bank-accounts/by-v1-id/:v1_bank_account_idReturns details of a BankAccount identified by V1 bank account ID. - GETGetBankAccount
/v2/bank-accounts/:bank_account_idRetrieve details of a BankAccount bank account linked to a Square account. - POSTDisableBankAccount
/v2/bank-accounts/:bank_account_id/disableDisable a bank account.
Bookings
- GETListBookings
/v2/bookings?limit=0&cursor=string&customer_id=string&team_member_id=string&location_id=string&start_at_min=string&start_at_max=stringRetrieve a collection of bookings. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint with… - POSTCreateBooking
/v2/bookingsCreates a booking. The required input must include the following: Booking.location_id Booking.start_at Booking.AppointmentSegment.team_member_id… - POSTSearchAvailability
/v2/bookings/availability/searchSearches for availabilities for booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint… - POSTBulkRetrieveBookings
/v2/bookings/bulk-retrieveBulk-Retrieves a list of bookings by booking IDs. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this… - GETRetrieveBusinessBookingProfile
/v2/bookings/business-booking-profileRetrieves a seller's booking profile. - GETListLocationBookingProfiles
/v2/bookings/location-booking-profiles?limit=0&cursor=stringLists location booking profiles of a seller. - GETRetrieveLocationBookingProfile
/v2/bookings/location-booking-profiles/:location_idRetrieves a seller's location booking profile. - GETListTeamMemberBookingProfiles
/v2/bookings/team-member-booking-profiles?bookable_only=false&limit=0&cursor=string&location_id=stringLists booking profiles for team members. - POSTBulkRetrieveTeamMemberBookingProfiles
/v2/bookings/team-member-booking-profiles/bulk-retrieveRetrieves one or more team members' booking profiles. - GETRetrieveTeamMemberBookingProfile
/v2/bookings/team-member-booking-profiles/:team_member_idRetrieves a team member's booking profile. - GETRetrieveBooking
/v2/bookings/:booking_idRetrieves a booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint with seller-level… - PUTUpdateBooking
/v2/bookings/:booking_idUpdates a booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint with seller-level… - POSTCancelBooking
/v2/bookings/:booking_id/cancelCancels an existing booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint with…
BookingCustomAttributes
- GETListBookingCustomAttributeDefinitions
/v2/bookings/custom-attribute-definitions?limit=0&cursor=stringGet all bookings custom attribute definitions. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this… - POSTCreateBookingCustomAttributeDefinition
/v2/bookings/custom-attribute-definitionsCreates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this… - GETRetrieveBookingCustomAttributeDefinition
/v2/bookings/custom-attribute-definitions/:key?version=0Retrieves a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this… - PUTUpdateBookingCustomAttributeDefinition
/v2/bookings/custom-attribute-definitions/:keyUpdates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this… - DELETEDeleteBookingCustomAttributeDefinition
/v2/bookings/custom-attribute-definitions/:keyDeletes a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this… - POSTBulkDeleteBookingCustomAttributes
/v2/bookings/custom-attributes/bulk-deleteBulk deletes bookings custom attributes. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint… - POSTBulkUpsertBookingCustomAttributes
/v2/bookings/custom-attributes/bulk-upsertBulk upserts bookings custom attributes. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint… - GETListBookingCustomAttributes
/v2/bookings/:booking_id/custom-attributes?limit=0&cursor=string&with_definitions=falseLists a booking's custom attributes. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint with… - GETRetrieveBookingCustomAttribute
/v2/bookings/:booking_id/custom-attributes/:key?with_definition=false&version=0Retrieves a bookings custom attribute. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint… - PUTUpsertBookingCustomAttribute
/v2/bookings/:booking_id/custom-attributes/:keyUpserts a bookings custom attribute. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint… - DELETEDeleteBookingCustomAttribute
/v2/bookings/:booking_id/custom-attributes/:keyDeletes a bookings custom attribute. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint…
Cards
- GETListCards
/v2/cards?cursor=string&customer_id=string&include_disabled=false&reference_id=string&sort_order=DESCRetrieves a list of cards owned by the account making the request. A max of 25 cards will be returned. - POSTCreateCard
/v2/cardsAdds a card on file to an existing merchant. - GETRetrieveCard
/v2/cards/:card_idRetrieves details for a specific Card. - POSTDisableCard
/v2/cards/:card_id/disableDisables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect.
CashDrawers
- GETListCashDrawerShifts
/v2/cash-drawers/shifts?location_id=string&sort_order=DESC&begin_time=string&end_time=string&limit=0&cursor=stringProvides the details for all of the cash drawer shifts for a location in a date range. - GETRetrieveCashDrawerShift
/v2/cash-drawers/shifts/:shift_id?location_id=stringProvides the summary details for a single cash drawer shift. See ListCashDrawerShiftEvents for a list of cash drawer shift events. - GETListCashDrawerShiftEvents
/v2/cash-drawers/shifts/:shift_id/events?location_id=string&limit=0&cursor=stringProvides a paginated list of events for a single cash drawer shift.
Catalog
- POSTBatchDeleteCatalogObjects
/v2/catalog/batch-deleteDeletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading… - POSTBatchRetrieveCatalogObjects
/v2/catalog/batch-retrieveReturns a set of objects based on the provided ID. Each CatalogItem returned in the set includes all of its child information including: all of its… - POSTBatchUpsertCatalogObjects
/v2/catalog/batch-upsertCreates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is… - POSTCreateCatalogImage
/v2/catalog/imagesUploads an image file to be represented by a CatalogImage object that can be linked to an existing CatalogObject instance. The resulting CatalogImage is… - PUTUpdateCatalogImage
/v2/catalog/images/:image_idUploads a new image file to replace the existing one in the specified CatalogImage object. This UpdateCatalogImage endpoint accepts HTTP multipart/form-data… - GETCatalogInfo
/v2/catalog/infoRetrieves information about the Square Catalog API, such as batch size limits that can be used by the BatchUpsertCatalogObjects endpoint. - GETListCatalog
/v2/catalog/list?cursor=string&types=string&catalog_version=0Returns a list of all CatalogObjects of the specified types in the catalog. The types parameter is specified as a comma-separated list of the… - POSTUpsertCatalogObject
/v2/catalog/objectCreates a new or updates the specified CatalogObject. This endpoint uses full-replacement semantics. The client must send the complete object, and any field… - GETRetrieveCatalogObject
/v2/catalog/object/:object_id?include_related_objects=false&catalog_version=0&include_category_path_to_root=falseReturns a single CatalogItem as a CatalogObject based on the provided ID. The returned object includes all of the relevant CatalogItem information including:… - DELETEDeleteCatalogObject
/v2/catalog/object/:object_idDeletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such… - POSTSearchCatalogObjects
/v2/catalog/searchSearches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against… - POSTSearchCatalogItems
/v2/catalog/search-catalog-itemsSearches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the… - POSTUpdateItemModifierLists
/v2/catalog/update-item-modifier-listsUpdates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item. - POSTUpdateItemTaxes
/v2/catalog/update-item-taxesUpdates the CatalogTax objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.
Channels
- GETListChannels
/v2/channels?reference_type=UNKNOWN_TYPE&reference_id=string&status=ACTIVE&cursor=string&limit=0 - POSTBulkRetrieveChannels
/v2/channels/bulk-retrieve - GETRetrieveChannel
/v2/channels/:channel_id
Customers
- GETListCustomers
/v2/customers?cursor=string&limit=0&sort_field=DEFAULT&sort_order=DESC&count=falseLists customer profiles associated with a Square account. Under normal operating conditions, newly created or updated customer profiles become available for… - POSTCreateCustomer
/v2/customersCreates a new customer for a business. You must provide at least one of the following values in your request to this endpoint: given_name family_name… - POSTBulkCreateCustomers
/v2/customers/bulk-createCreates multiple customer profiles for a business. This endpoint takes a map of individual create requests and returns a map of responses. You must provide at… - POSTBulkDeleteCustomers
/v2/customers/bulk-deleteDeletes multiple customer profiles. The endpoint takes a list of customer IDs and returns a map of responses. - POSTBulkRetrieveCustomers
/v2/customers/bulk-retrieveRetrieves multiple customer profiles. This endpoint takes a list of customer IDs and returns a map of responses. - POSTBulkUpdateCustomers
/v2/customers/bulk-updateUpdates multiple customer profiles. This endpoint takes a map of individual update requests and returns a map of responses. - POSTSearchCustomers
/v2/customers/searchSearches the customer profiles associated with a Square account using one or more supported query filters. Calling SearchCustomers without any explicit query… - GETRetrieveCustomer
/v2/customers/:customer_idReturns details for a single customer. - PUTUpdateCustomer
/v2/customers/:customer_idUpdates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field,… - DELETEDeleteCustomer
/v2/customers/:customer_id?version=0Deletes a customer profile from a business. To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly… - POSTCreateCustomerCard
/v2/customers/:customer_id/cardsDeprecated. Adds a card on file to an existing customer. As with charges, calls to CreateCustomerCard are idempotent. Multiple calls with the same card nonce… - DELETEDeleteCustomerCard
/v2/customers/:customer_id/cards/:card_idDeprecated. Removes a card on file from a customer. - PUTAddGroupToCustomer
/v2/customers/:customer_id/groups/:group_idAdds a group membership to a customer. The customer is identified by the customer_id value and the customer group is identified by the group_id value. - DELETERemoveGroupFromCustomer
/v2/customers/:customer_id/groups/:group_idRemoves a group membership from a customer. The customer is identified by the customer_id value and the customer group is identified by the group_id value.
CustomerCustomAttributes
- GETListCustomerCustomAttributeDefinitions
/v2/customers/custom-attribute-definitions?limit=0&cursor=stringLists the customer-related custom attribute definitions that belong to a Square seller account. When all response pages are retrieved, the results include all… - POSTCreateCustomerCustomAttributeDefinition
/v2/customers/custom-attribute-definitionsCreates a customer-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with… - GETRetrieveCustomerCustomAttributeDefinition
/v2/customers/custom-attribute-definitions/:key?version=0Retrieves a customer-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another… - PUTUpdateCustomerCustomAttributeDefinition
/v2/customers/custom-attribute-definitions/:keyUpdates a customer-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description,… - DELETEDeleteCustomerCustomAttributeDefinition
/v2/customers/custom-attribute-definitions/:keyDeletes a customer-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding… - POSTBulkUpsertCustomerCustomAttributes
/v2/customers/custom-attributes/bulk-upsertCreates or updates custom attributes for customer profiles as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or… - GETListCustomerCustomAttributes
/v2/customers/:customer_id/custom-attributes?limit=0&cursor=string&with_definitions=falseLists the custom attributes associated with a customer profile. You can use the with_definitions query parameter to also retrieve custom attribute definitions… - GETRetrieveCustomerCustomAttribute
/v2/customers/:customer_id/custom-attributes/:key?with_definition=false&version=0Retrieves a custom attribute associated with a customer profile. You can use the with_definition query parameter to also retrieve the custom attribute… - POSTUpsertCustomerCustomAttribute
/v2/customers/:customer_id/custom-attributes/:keyCreates or updates a custom attribute for a customer profile. Use this endpoint to set the value of a custom attribute for a specified customer profile. A… - DELETEDeleteCustomerCustomAttribute
/v2/customers/:customer_id/custom-attributes/:keyDeletes a custom attribute associated with a customer profile. To delete a custom attribute owned by another application, the visibility setting must be…
CustomerGroups
- GETListCustomerGroups
/v2/customers/groups?cursor=string&limit=0Retrieves the list of customer groups of a business. - POSTCreateCustomerGroup
/v2/customers/groupsCreates a new customer group for a business. The request must include the name value of the group. - GETRetrieveCustomerGroup
/v2/customers/groups/:group_idRetrieves a specific customer group as identified by the group_id value. - PUTUpdateCustomerGroup
/v2/customers/groups/:group_idUpdates a customer group as identified by the group_id value. - DELETEDeleteCustomerGroup
/v2/customers/groups/:group_idDeletes a customer group as identified by the group_id value.
CustomerSegments
- GETListCustomerSegments
/v2/customers/segments?cursor=string&limit=0Retrieves the list of customer segments of a business. - GETRetrieveCustomerSegment
/v2/customers/segments/:segment_idRetrieves a specific customer segment as identified by the segment_id value.
Devices
- GETListDevices
/v2/devices?cursor=string&sort_order=DESC&limit=0&location_id=stringList devices associated with the merchant. Currently, only Terminal API devices are supported. - GETListDeviceCodes
/v2/devices/codes?cursor=string&location_id=string&product_type=TERMINAL_API&status=UNKNOWNLists all DeviceCodes associated with the merchant. - POSTCreateDeviceCode
/v2/devices/codesCreates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode. - GETGetDeviceCode
/v2/devices/codes/:idRetrieves DeviceCode with the associated ID. - GETGetDevice
/v2/devices/:device_idRetrieves Device with the associated device_id.
Disputes
- GETListDisputes
/v2/disputes?cursor=string&states=INQUIRY_EVIDENCE_REQUIRED&location_id=stringReturns a list of disputes associated with a particular account. - GETRetrieveDispute
/v2/disputes/:dispute_idReturns details about a specific dispute. - POSTAcceptDispute
/v2/disputes/:dispute_id/acceptAccepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Square debits the disputed… - GETListDisputeEvidence
/v2/disputes/:dispute_id/evidence?cursor=stringReturns a list of evidence associated with a dispute. - POSTCreateDisputeEvidenceFile
/v2/disputes/:dispute_id/evidence-filesUploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF… - POSTCreateDisputeEvidenceText
/v2/disputes/:dispute_id/evidence-textUploads text to use as evidence for a dispute challenge. - GETRetrieveDisputeEvidence
/v2/disputes/:dispute_id/evidence/:evidence_idReturns the metadata for the evidence specified in the request URL path. You must maintain a copy of any evidence uploaded if you want to reference it later.… - DELETEDeleteDisputeEvidence
/v2/disputes/:dispute_id/evidence/:evidence_idRemoves specified evidence from a dispute. Square does not send the bank any evidence that is removed. - POSTSubmitEvidence
/v2/disputes/:dispute_id/submit-evidenceSubmits evidence to the cardholder's bank. The evidence submitted by this endpoint includes evidence uploaded using the CreateDisputeEvidenceFile and…
Employees
- GETListEmployees
/v2/employees?location_id=string&status=ACTIVE&limit=0&cursor=stringDeprecated. - GETRetrieveEmployee
/v2/employees/:idDeprecated.
Events
- POSTSearchEvents
/v2/eventsSearch for Square API events that occur within a 28-day timeframe. - PUTDisableEvents
/v2/events/disableDisables events to prevent them from being searchable. All events are disabled by default. You must enable events to make them searchable. Disabling events… - PUTEnableEvents
/v2/events/enableEnables events to make them searchable. Only events that occur while in the enabled state are searchable. - GETListEventTypes
/v2/events/types?api_version=stringLists all event types that you can subscribe to as webhooks or query using the Events API.
GiftCards
- GETListGiftCards
/v2/gift-cards?type=string&state=string&limit=0&cursor=string&customer_id=stringLists all gift cards. You can specify optional filters to retrieve a subset of the gift cards. Results are sorted by created_at in ascending order. - POSTCreateGiftCard
/v2/gift-cardsCreates a digital gift card or registers a physical (plastic) gift card. The resulting gift card has a PENDING state. To activate a gift card so that it can… - POSTRetrieveGiftCardFromGAN
/v2/gift-cards/from-ganRetrieves a gift card using the gift card account number (GAN). - POSTRetrieveGiftCardFromNonce
/v2/gift-cards/from-nonceRetrieves a gift card using a secure payment token that represents the gift card. - POSTLinkCustomerToGiftCard
/v2/gift-cards/:gift_card_id/link-customerLinks a customer to a gift card, which is also referred to as adding a card on file. - POSTUnlinkCustomerFromGiftCard
/v2/gift-cards/:gift_card_id/unlink-customerUnlinks a customer from a gift card, which is also referred to as removing a card on file. - GETRetrieveGiftCard
/v2/gift-cards/:idRetrieves a gift card using the gift card ID.
GiftCardActivities
- GETListGiftCardActivities
/v2/gift-cards/activities?gift_card_id=string&type=string&location_id=string&begin_time=string&end_time=string&limit=0&cursor=string&sort_order=stringLists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters… - POSTCreateGiftCardActivity
/v2/gift-cards/activitiesCreates a gift card activity to manage the balance or state of a gift card. For example, create an ACTIVATE activity to activate a gift card with an initial…
Inventory
- GETListInventoryAdjustmentReasons
/v2/inventory/adjustment-reasons?include_deleted=false&include_system_codes=falseReturns the standard and custom inventory adjustment reasons available to the seller. - POSTCreateInventoryAdjustmentReason
/v2/inventory/adjustment-reasons/createCreates a custom inventory adjustment reason. - POSTDeleteInventoryAdjustmentReason
/v2/inventory/adjustment-reasons/deleteSoft deletes a custom inventory adjustment reason. - POSTRestoreInventoryAdjustmentReason
/v2/inventory/adjustment-reasons/restoreRestores a soft-deleted custom inventory adjustment reason. - POSTRetrieveInventoryAdjustmentReason
/v2/inventory/adjustment-reasons/retrieveReturns the inventory adjustment reason identified by the provided reason_id. Deleted custom reasons can be retrieved by ID. - PUTUpdateInventoryAdjustmentReason
/v2/inventory/adjustment-reasons/updateUpdates a custom inventory adjustment reason. - GETDeprecatedRetrieveInventoryAdjustment
/v2/inventory/adjustment/:adjustment_idDeprecated. Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention. - PUTUpdateInventoryAdjustment
/v2/inventory/adjustments/updateApplies an update to the provided adjustment. On success: returns the newly updated adjustment. On failure: returns a list of related errors. - GETRetrieveInventoryAdjustment
/v2/inventory/adjustments/:adjustment_idReturns the InventoryAdjustment object with the provided adjustment_id. - POSTDeprecatedBatchChangeInventory
/v2/inventory/batch-changeDeprecated. Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention. - POSTDeprecatedBatchRetrieveInventoryChanges
/v2/inventory/batch-retrieve-changesDeprecated. Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention. - POSTDeprecatedBatchRetrieveInventoryCounts
/v2/inventory/batch-retrieve-countsDeprecated. Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention. - POSTBatchChangeInventory
/v2/inventory/changes/batch-createApplies adjustments and counts to the provided item quantities. On success: returns the current calculated counts for all objects referenced in the request.… - POSTBatchRetrieveInventoryChanges
/v2/inventory/changes/batch-retrieveReturns historical physical counts and adjustments based on the provided filter criteria. Results are paginated and sorted in ascending order according their… - POSTBatchRetrieveInventoryCounts
/v2/inventory/counts/batch-retrieveReturns current counts for the provided CatalogObjects at the requested Locations. Results are paginated and sorted in descending order according to their… - GETDeprecatedRetrieveInventoryPhysicalCount
/v2/inventory/physical-count/:physical_count_idDeprecated. Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention. - GETRetrieveInventoryPhysicalCount
/v2/inventory/physical-counts/:physical_count_idReturns the InventoryPhysicalCount object with the provided physical_count_id. - GETRetrieveInventoryCount
/v2/inventory/:catalog_object_id?location_ids=string&cursor=stringRetrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more… - GETRetrieveInventoryChanges
/v2/inventory/:catalog_object_id/changes?location_ids=string&cursor=stringDeprecated. Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations. You can achieve the same…
Invoices
- GETListInvoices
/v2/invoices?location_id=string&cursor=string&limit=0Returns a list of invoices for a given location. The response is paginated. If truncated, the response includes a cursor that you use in a subsequent request… - POSTCreateInvoice
/v2/invoicesCreates a draft invoice for an order created using the Orders API. A draft invoice remains in your account and no action is taken. You must publish the… - POSTSearchInvoices
/v2/invoices/searchSearches for invoices from a location specified in the filter. You can optionally specify customers in the filter for whom to retrieve invoices. In the… - GETGetInvoice
/v2/invoices/:invoice_idRetrieves an invoice by invoice ID. - PUTUpdateInvoice
/v2/invoices/:invoice_idUpdates an invoice. This endpoint supports sparse updates, so you only need to specify the fields you want to change along with the required version field.… - DELETEDeleteInvoice
/v2/invoices/:invoice_id?version=0Deletes the specified invoice. When an invoice is deleted, the associated order status changes to CANCELED. You can only delete a draft invoice (you cannot… - POSTCreateInvoiceAttachment
/v2/invoices/:invoice_id/attachmentsUploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads with a JSON request part and a file part. The file… - DELETEDeleteInvoiceAttachment
/v2/invoices/:invoice_id/attachments/:attachment_idRemoves an attachment from an invoice and permanently deletes the file. Attachments can be removed only from invoices in the DRAFT, SCHEDULED, UNPAID, or… - POSTCancelInvoice
/v2/invoices/:invoice_id/cancelCancels an invoice. The seller cannot collect payments for the canceled invoice. You cannot cancel an invoice in the DRAFT state or in a terminal state: PAID,… - POSTPublishInvoice
/v2/invoices/:invoice_id/publishPublishes the specified draft invoice. After an invoice is published, Square follows up based on the invoice configuration. For example, Square sends the…
Labor
- GETListBreakTypes
/v2/labor/break-types?location_id=string&limit=0&cursor=stringReturns a paginated list of BreakType instances for a business. - POSTCreateBreakType
/v2/labor/break-typesCreates a new BreakType. A BreakType is a template for creating Break objects. You must provide the following values in your request to this endpoint:… - GETGetBreakType
/v2/labor/break-types/:idReturns a single BreakType specified by id. - PUTUpdateBreakType
/v2/labor/break-types/:idUpdates an existing BreakType. - DELETEDeleteBreakType
/v2/labor/break-types/:idDeletes an existing BreakType. A BreakType can be deleted even if it is referenced from a Shift. - GETListEmployeeWages
/v2/labor/employee-wages?employee_id=string&limit=0&cursor=stringDeprecated. Returns a paginated list of EmployeeWage instances for a business. - GETGetEmployeeWage
/v2/labor/employee-wages/:idDeprecated. Returns a single EmployeeWage specified by id. - POSTCreateScheduledShift
/v2/labor/scheduled-shiftsCreates a scheduled shift by providing draft shift details such as job ID, team member assignment, and start and end times. The following draft_shift_details… - POSTBulkPublishScheduledShifts
/v2/labor/scheduled-shifts/bulk-publishPublishes 1 - 100 scheduled shifts. This endpoint takes a map of individual publish requests and returns a map of responses. When a scheduled shift is… - POSTSearchScheduledShifts
/v2/labor/scheduled-shifts/searchReturns a paginated list of scheduled shifts, with optional filter and sort settings. By default, results are sorted by start_at in ascending order. - GETRetrieveScheduledShift
/v2/labor/scheduled-shifts/:idRetrieves a scheduled shift by ID. - PUTUpdateScheduledShift
/v2/labor/scheduled-shifts/:idUpdates the draft shift details for a scheduled shift. This endpoint supports sparse updates, so only new, changed, or removed fields are required in the… - POSTPublishScheduledShift
/v2/labor/scheduled-shifts/:id/publishPublishes a scheduled shift. When a scheduled shift is published, Square keeps the draft_shift_details field as is and copies it to the… - POSTCreateShift
/v2/labor/shiftsDeprecated. Creates a new Shift. A Shift represents a complete workday for a single team member. You must provide the following values in your request to this… - POSTSearchShifts
/v2/labor/shifts/searchDeprecated. Returns a paginated list of Shift records for a business. The list to be returned can be filtered by: Location IDs Team member IDs Shift status… - GETGetShift
/v2/labor/shifts/:idDeprecated. Returns a single Shift specified by id. - PUTUpdateShift
/v2/labor/shifts/:idDeprecated. Updates an existing Shift. When adding a Break to a Shift, any earlier Break instances in the Shift have the end_at property set to a valid… - DELETEDeleteShift
/v2/labor/shifts/:idDeprecated. Deletes a Shift. - GETListTeamMemberWages
/v2/labor/team-member-wages?team_member_id=string&limit=0&cursor=stringReturns a paginated list of TeamMemberWage instances for a business. - GETGetTeamMemberWage
/v2/labor/team-member-wages/:idReturns a single TeamMemberWage specified by id. - POSTCreateTimecard
/v2/labor/timecardsCreates a new Timecard. A Timecard represents a complete workday for a single team member. You must provide the following values in your request to this… - POSTSearchTimecards
/v2/labor/timecards/searchReturns a paginated list of Timecard records for a business. The list to be returned can be filtered by: Location IDs Team member IDs Timecard status (OPEN or… - GETRetrieveTimecard
/v2/labor/timecards/:idReturns a single Timecard specified by id. - PUTUpdateTimecard
/v2/labor/timecards/:idUpdates an existing Timecard. When adding a Break to a Timecard, any earlier Break instances in the Timecard have the end_at property set to a valid RFC-3339… - DELETEDeleteTimecard
/v2/labor/timecards/:idDeletes a Timecard. - GETListWorkweekConfigs
/v2/labor/workweek-configs?limit=0&cursor=stringReturns a list of WorkweekConfig instances for a business. - PUTUpdateWorkweekConfig
/v2/labor/workweek-configs/:idUpdates a WorkweekConfig.
Locations
- GETListLocations
/v2/locationsProvides details about all of the seller's locations, including those with an inactive status. Locations are listed alphabetically by name. - POSTCreateLocation
/v2/locationsCreates a location. Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations… - GETRetrieveLocation
/v2/locations/:location_idRetrieves details of a single location. Specify "main" as the location ID to retrieve details of the main location. - PUTUpdateLocation
/v2/locations/:location_idUpdates a location.
LocationCustomAttributes
- GETListLocationCustomAttributeDefinitions
/v2/locations/custom-attribute-definitions?visibility_filter=ALL&limit=0&cursor=stringLists the location-related custom attribute definitions that belong to a Square seller account. When all response pages are retrieved, the results include all… - POSTCreateLocationCustomAttributeDefinition
/v2/locations/custom-attribute-definitionsCreates a location-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with… - GETRetrieveLocationCustomAttributeDefinition
/v2/locations/custom-attribute-definitions/:key?version=0Retrieves a location-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another… - PUTUpdateLocationCustomAttributeDefinition
/v2/locations/custom-attribute-definitions/:keyUpdates a location-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description,… - DELETEDeleteLocationCustomAttributeDefinition
/v2/locations/custom-attribute-definitions/:keyDeletes a location-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding… - POSTBulkDeleteLocationCustomAttributes
/v2/locations/custom-attributes/bulk-deleteDeletes custom attributes for locations as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be… - POSTBulkUpsertLocationCustomAttributes
/v2/locations/custom-attributes/bulk-upsertCreates or updates custom attributes for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more… - GETListLocationCustomAttributes
/v2/locations/:location_id/custom-attributes?visibility_filter=ALL&limit=0&cursor=string&with_definitions=falseLists the custom attributes associated with a location. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the… - GETRetrieveLocationCustomAttribute
/v2/locations/:location_id/custom-attributes/:key?with_definition=false&version=0Retrieves a custom attribute associated with a location. You can use the with_definition query parameter to also retrieve the custom attribute definition in… - POSTUpsertLocationCustomAttribute
/v2/locations/:location_id/custom-attributes/:keyCreates or updates a custom attribute for a location. Use this endpoint to set the value of a custom attribute for a specified location. A custom attribute is… - DELETEDeleteLocationCustomAttribute
/v2/locations/:location_id/custom-attributes/:keyDeletes a custom attribute associated with a location. To delete a custom attribute owned by another application, the visibility setting must be…
Checkout
- POSTCreateCheckout
/v2/locations/:location_id/checkoutsDeprecated. Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing… - GETRetrieveLocationSettings
/v2/online-checkout/location-settings/:location_idRetrieves the location-level settings for a Square-hosted checkout page. - PUTUpdateLocationSettings
/v2/online-checkout/location-settings/:location_idUpdates the location-level settings for a Square-hosted checkout page. - GETRetrieveMerchantSettings
/v2/online-checkout/merchant-settingsRetrieves the merchant-level settings for a Square-hosted checkout page. - PUTUpdateMerchantSettings
/v2/online-checkout/merchant-settingsUpdates the merchant-level settings for a Square-hosted checkout page. - GETListPaymentLinks
/v2/online-checkout/payment-links?cursor=string&limit=0Lists all payment links. - POSTCreatePaymentLink
/v2/online-checkout/payment-linksCreates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. - GETRetrievePaymentLink
/v2/online-checkout/payment-links/:idRetrieves a payment link. - PUTUpdatePaymentLink
/v2/online-checkout/payment-links/:idUpdates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data. You cannot update other fields… - DELETEDeletePaymentLink
/v2/online-checkout/payment-links/:idDeletes a payment link.
Transactions
- GETListTransactions
/v2/locations/:location_id/transactions?begin_time=string&end_time=string&sort_order=DESC&cursor=stringDeprecated. Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from… - GETRetrieveTransaction
/v2/locations/:location_id/transactions/:transaction_idDeprecated. Retrieves details for a single transaction.
Loyalty
- POSTCreateLoyaltyAccount
/v2/loyalty/accountsCreates a loyalty account. To create a loyalty account, you must provide the program_id and a mapping with the phone_number of the buyer. - POSTSearchLoyaltyAccounts
/v2/loyalty/accounts/searchSearches for loyalty accounts in a loyalty program. You can search for a loyalty account using the phone number or customer ID associated with the account. To… - GETRetrieveLoyaltyAccount
/v2/loyalty/accounts/:account_idRetrieves a loyalty account. - POSTAccumulateLoyaltyPoints
/v2/loyalty/accounts/:account_id/accumulateAdds points earned from a purchase to a loyalty account. If you are using the Orders API to manage orders, provide the order_id. Square reads the order to… - POSTAdjustLoyaltyPoints
/v2/loyalty/accounts/:account_id/adjustAdds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points. Otherwise, in your application… - POSTSearchLoyaltyEvents
/v2/loyalty/events/searchSearches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in… - GETListLoyaltyPrograms
/v2/loyalty/programsDeprecated. Returns a list of loyalty programs in the seller's account. Loyalty programs define how buyers can earn points and redeem points for rewards.… - GETRetrieveLoyaltyProgram
/v2/loyalty/programs/:program_idRetrieves the loyalty program in a seller's account, specified by the program ID or the keyword main. Loyalty programs define how buyers can earn points and… - POSTCalculateLoyaltyPoints
/v2/loyalty/programs/:program_id/calculateCalculates the number of points a buyer can earn from a purchase. Applications might call this endpoint to display the points to the buyer. If you are using… - GETListLoyaltyPromotions
/v2/loyalty/programs/:program_id/promotions?status=ACTIVE&cursor=string&limit=0Lists the loyalty promotions associated with a loyalty program. Results are sorted by the created_at date in descending order (newest to oldest). - POSTCreateLoyaltyPromotion
/v2/loyalty/programs/:program_id/promotionsCreates a loyalty promotion for a loyalty program. A loyalty promotion enables buyers to earn points in addition to those earned from the base loyalty… - GETRetrieveLoyaltyPromotion
/v2/loyalty/programs/:program_id/promotions/:promotion_idRetrieves a loyalty promotion. - POSTCancelLoyaltyPromotion
/v2/loyalty/programs/:program_id/promotions/:promotion_id/cancelCancels a loyalty promotion. Use this endpoint to cancel an ACTIVE promotion earlier than the end date, cancel an ACTIVE promotion when an end date is not… - POSTCreateLoyaltyReward
/v2/loyalty/rewardsCreates a loyalty reward. In the process, the endpoint does following: Uses the reward_tier_id in the request to determine the number of points to lock for… - POSTSearchLoyaltyRewards
/v2/loyalty/rewards/searchSearches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. If you include a query… - GETRetrieveLoyaltyReward
/v2/loyalty/rewards/:reward_idRetrieves a loyalty reward. - DELETEDeleteLoyaltyReward
/v2/loyalty/rewards/:reward_idDeletes a loyalty reward by doing the following: Returns the loyalty points back to the loyalty account. If an order ID was specified when the reward was… - POSTRedeemLoyaltyReward
/v2/loyalty/rewards/:reward_id/redeemRedeems a loyalty reward. The endpoint sets the reward to the REDEEMED terminal state. If you are using your own order processing system (not using the Orders…
Merchants
- GETListMerchants
/v2/merchants?cursor=0Provides details about the merchant associated with a given access token. The access token used to connect your application to a Square seller is associated… - GETRetrieveMerchant
/v2/merchants/:merchant_idRetrieves the Merchant object for the given merchant_id.
MerchantCustomAttributes
- GETListMerchantCustomAttributeDefinitions
/v2/merchants/custom-attribute-definitions?visibility_filter=ALL&limit=0&cursor=stringLists the merchant-related custom attribute definitions that belong to a Square seller account. When all response pages are retrieved, the results include all… - POSTCreateMerchantCustomAttributeDefinition
/v2/merchants/custom-attribute-definitionsCreates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with… - GETRetrieveMerchantCustomAttributeDefinition
/v2/merchants/custom-attribute-definitions/:key?version=0Retrieves a merchant-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another… - PUTUpdateMerchantCustomAttributeDefinition
/v2/merchants/custom-attribute-definitions/:keyUpdates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description,… - DELETEDeleteMerchantCustomAttributeDefinition
/v2/merchants/custom-attribute-definitions/:keyDeletes a merchant-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding… - POSTBulkDeleteMerchantCustomAttributes
/v2/merchants/custom-attributes/bulk-deleteDeletes custom attributes for a merchant as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be… - POSTBulkUpsertMerchantCustomAttributes
/v2/merchants/custom-attributes/bulk-upsertCreates or updates custom attributes for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. A… - GETListMerchantCustomAttributes
/v2/merchants/:merchant_id/custom-attributes?visibility_filter=ALL&limit=0&cursor=string&with_definitions=falseLists the custom attributes associated with a merchant. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the… - GETRetrieveMerchantCustomAttribute
/v2/merchants/:merchant_id/custom-attributes/:key?with_definition=false&version=0Retrieves a custom attribute associated with a merchant. You can use the with_definition query parameter to also retrieve the custom attribute definition in… - POSTUpsertMerchantCustomAttribute
/v2/merchants/:merchant_id/custom-attributes/:keyCreates or updates a custom attribute for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. A custom attribute is… - DELETEDeleteMerchantCustomAttribute
/v2/merchants/:merchant_id/custom-attributes/:keyDeletes a custom attribute associated with a merchant. To delete a custom attribute owned by another application, the visibility setting must be…
Orders
- POSTCreateOrder
/v2/ordersCreates a new order that can include information about products for purchase and settings to apply to the purchase. To pay for a created order, see Pay for… - POSTBatchRetrieveOrders
/v2/orders/batch-retrieveRetrieves a set of orders by their IDs. If a given order ID does not exist, the ID is ignored instead of generating an error. - POSTCalculateOrder
/v2/orders/calculateEnables applications to preview order pricing without creating an order. - POSTCloneOrder
/v2/orders/cloneCreates a new order, in the DRAFT state, by duplicating an existing order. The newly created order has only the core fields (such as line items, taxes, and… - POSTSearchOrders
/v2/orders/searchSearch all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem… - GETRetrieveOrder
/v2/orders/:order_idRetrieves an Order by ID. - PUTUpdateOrder
/v2/orders/:order_idUpdates an open order by adding, replacing, or deleting fields. Orders with a COMPLETED or CANCELED state cannot be updated. An UpdateOrder request requires… - POSTPayOrder
/v2/orders/:order_id/payPay for an order using one or more approved payments or settle an order with a total of 0. The total of the payment_ids listed in the request must be equal to…
OrderCustomAttributes
- GETListOrderCustomAttributeDefinitions
/v2/orders/custom-attribute-definitions?visibility_filter=ALL&cursor=string&limit=0Lists the order-related custom attribute definitions that belong to a Square seller account. When all response pages are retrieved, the results include all… - POSTCreateOrderCustomAttributeDefinition
/v2/orders/custom-attribute-definitionsCreates an order-related custom attribute definition. Use this endpoint to define a custom attribute that can be associated with orders. After creating a… - GETRetrieveOrderCustomAttributeDefinition
/v2/orders/custom-attribute-definitions/:key?version=0Retrieves an order-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another application,… - PUTUpdateOrderCustomAttributeDefinition
/v2/orders/custom-attribute-definitions/:keyUpdates an order-related custom attribute definition for a Square seller account. Only the definition owner can update a custom attribute definition. Note… - DELETEDeleteOrderCustomAttributeDefinition
/v2/orders/custom-attribute-definitions/:keyDeletes an order-related custom attribute definition from a Square seller account. Only the definition owner can delete a custom attribute definition. - POSTBulkDeleteOrderCustomAttributes
/v2/orders/custom-attributes/bulk-deleteDeletes order custom attributes as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is… - POSTBulkUpsertOrderCustomAttributes
/v2/orders/custom-attributes/bulk-upsertCreates or updates order custom attributes as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom… - GETListOrderCustomAttributes
/v2/orders/:order_id/custom-attributes?visibility_filter=ALL&cursor=string&limit=0&with_definitions=falseLists the custom attributes associated with an order. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the… - GETRetrieveOrderCustomAttribute
/v2/orders/:order_id/custom-attributes/:custom_attribute_key?version=0&with_definition=falseRetrieves a custom attribute associated with an order. You can use the with_definition query parameter to also retrieve the custom attribute definition in the… - POSTUpsertOrderCustomAttribute
/v2/orders/:order_id/custom-attributes/:custom_attribute_keyCreates or updates a custom attribute for an order. Use this endpoint to set the value of a custom attribute for a specific order. A custom attribute is based… - DELETEDeleteOrderCustomAttribute
/v2/orders/:order_id/custom-attributes/:custom_attribute_keyDeletes a custom attribute associated with a customer profile. To delete a custom attribute owned by another application, the visibility setting must be…
Payments
- GETListPayments
/v2/payments?begin_time=string&end_time=string&sort_order=string&cursor=string&location_id=string&total=0&last_4=string&card_brand=string&limit=0&is_offline_payment=false&offline_begin_time=string&offline_end_time=string&updated_at_begin_time=string&updated_at_end_time=string&sort_field=CREATED_ATRetrieves a list of payments taken by the account making the request. Results are eventually consistent, and new payments or changes to payments might take… - POSTCreatePayment
/v2/paymentsCreates a payment using the provided source. You can use this endpoint to charge a card (credit/debit card or Square gift card) or record a payment that the… - POSTCancelPaymentByIdempotencyKey
/v2/payments/cancelCancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when the status of a CreatePayment request is… - GETGetPayment
/v2/payments/:payment_idRetrieves details for a specific payment. - PUTUpdatePayment
/v2/payments/:payment_idUpdates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint. - POSTCancelPayment
/v2/payments/:payment_id/cancelCancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED status. - POSTCompletePayment
/v2/payments/:payment_id/completeCompletes (captures) a payment. By default, payments are set to complete immediately after they are created. You can use this endpoint to complete a payment…
Payouts
- GETListPayouts
/v2/payouts?location_id=string&status=SENT&begin_time=string&end_time=string&sort_order=DESC&cursor=string&limit=0Retrieves a list of all payouts for the default location. You can filter payouts by location ID, status, time range, and order them in ascending or descending… - GETGetPayout
/v2/payouts/:payout_idRetrieves details of a specific payout identified by a payout ID. To call this endpoint, set PAYOUTS_READ for the OAuth scope. - GETListPayoutEntries
/v2/payouts/:payout_id/payout-entries?sort_order=DESC&cursor=string&limit=0Retrieves a list of all payout entries for a specific payout. To call this endpoint, set PAYOUTS_READ for the OAuth scope.
Refunds
- GETListPaymentRefunds
/v2/refunds?begin_time=string&end_time=string&sort_order=string&cursor=string&location_id=string&status=string&source_type=string&limit=0&updated_at_begin_time=string&updated_at_end_time=string&sort_field=CREATED_ATRetrieves a list of refunds for the account making the request. Results are eventually consistent, and new refunds or changes to refunds might take several… - POSTRefundPayment
/v2/refundsRefunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a… - GETGetPaymentRefund
/v2/refunds/:refund_idRetrieves a specific refund using the refund_id.
Sites
- GETListSites
/v2/sitesLists the Square Online sites that belong to a seller. Sites are listed in descending order by the created_at date. __Note:__ Square Online APIs are publicly…
Snippets
- GETRetrieveSnippet
/v2/sites/:site_id/snippetRetrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that… - POSTUpsertSnippet
/v2/sites/:site_id/snippetAdds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the head element on every page… - DELETEDeleteSnippet
/v2/sites/:site_id/snippetRemoves your snippet from a Square Online site. You can call ListSites to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are…
Subscriptions
- POSTCreateSubscription
/v2/subscriptionsEnrolls a customer in a subscription. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square sends an… - POSTBulkSwapPlan
/v2/subscriptions/bulk-swap-planSchedules a plan variation change for all active subscriptions under a given plan variation. For more information, see Swap Subscription Plan Variations. - POSTSearchSubscriptions
/v2/subscriptions/searchSearches for subscriptions. Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the… - GETRetrieveSubscription
/v2/subscriptions/:subscription_id?include=stringRetrieves a specific subscription. - PUTUpdateSubscription
/v2/subscriptions/:subscription_idUpdates a subscription by modifying or clearing subscription field values. To clear a field, set its value to null. - DELETEDeleteSubscriptionAction
/v2/subscriptions/:subscription_id/actions/:action_idDeletes a scheduled action for a subscription. - POSTChangeBillingAnchorDate
/v2/subscriptions/:subscription_id/billing-anchorChanges the billing anchor date for a subscription. - POSTCancelSubscription
/v2/subscriptions/:subscription_id/cancelSchedules a CANCEL action to cancel an active subscription. This sets the canceled_date field to the end of the active billing period. After this date, the… - GETListSubscriptionEvents
/v2/subscriptions/:subscription_id/events?cursor=string&limit=0Lists all events for a specific subscription. - POSTPauseSubscription
/v2/subscriptions/:subscription_id/pauseSchedules a PAUSE action to pause an active subscription. - POSTResumeSubscription
/v2/subscriptions/:subscription_id/resumeSchedules a RESUME action to resume a paused or a deactivated subscription. - POSTSwapPlan
/v2/subscriptions/:subscription_id/swap-planSchedules a SWAP_PLAN action to swap a subscription plan variation in an existing subscription. For more information, see Swap Subscription Plan Variations.
Team
- POSTCreateTeamMember
/v2/team-membersCreates a single TeamMember object. The TeamMember object is returned on successful creates. You must provide the following values in your request to this… - POSTBulkCreateTeamMembers
/v2/team-members/bulk-createCreates multiple TeamMember objects. The created TeamMember objects are returned on successful creates. This process is non-transactional and processes as… - POSTBulkUpdateTeamMembers
/v2/team-members/bulk-updateUpdates multiple TeamMember objects. The updated TeamMember objects are returned on successful updates. This process is non-transactional and processes as… - GETListJobs
/v2/team-members/jobs?cursor=stringLists jobs in a seller account. Results are sorted by title in ascending order. - POSTCreateJob
/v2/team-members/jobsCreates a job in a seller account. A job defines a title and tip eligibility. Note that compensation is defined in a job assignment in a team member's wage… - GETRetrieveJob
/v2/team-members/jobs/:job_idRetrieves a specified job. - PUTUpdateJob
/v2/team-members/jobs/:job_idUpdates the title or tip eligibility of a job. Changes to the title propagate to all JobAssignment, Shift, and TeamMemberWage objects that reference the job… - POSTSearchTeamMembers
/v2/team-members/searchReturns a paginated list of TeamMember objects for a business. The list can be filtered by location IDs, ACTIVE or INACTIVE status, or whether the team member… - GETRetrieveTeamMember
/v2/team-members/:team_member_idRetrieves a TeamMember object for the given TeamMember.id. Learn about Troubleshooting the Team API. - PUTUpdateTeamMember
/v2/team-members/:team_member_idUpdates a single TeamMember object. The TeamMember object is returned on successful updates. Learn about Troubleshooting the Team API. - GETRetrieveWageSetting
/v2/team-members/:team_member_id/wage-settingRetrieves a WageSetting object for a team member specified by TeamMember.id. For more information, see Troubleshooting the Team API. Square recommends using… - PUTUpdateWageSetting
/v2/team-members/:team_member_id/wage-settingCreates or updates a WageSetting object. The object is created if a WageSetting with the specified team_member_id doesn't exist. Otherwise, it fully replaces…
Terminal
- POSTCreateTerminalAction
/v2/terminals/actionsCreates a Terminal action request and sends it to the specified device. - POSTSearchTerminalActions
/v2/terminals/actions/searchRetrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days. - GETGetTerminalAction
/v2/terminals/actions/:action_idRetrieves a Terminal action request by action_id. Terminal action requests are available for 30 days. - POSTCancelTerminalAction
/v2/terminals/actions/:action_id/cancelCancels a Terminal action request if the status of the request permits it. - POSTDismissTerminalAction
/v2/terminals/actions/:action_id/dismissDismisses a Terminal action request if the status and type of the request permits it. See Link and Dismiss Actions for more details. - POSTCreateTerminalCheckout
/v2/terminals/checkoutsCreates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
Showing 300 of 332 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://connect.squareup.com- Authentication
- OAuth 2.0 (authorization code flow) with 60 scopes
An API key in the Authorization header - Operations
- 332 operations on 253 pathsPOST 148GET 121PUT 36DELETE 27
24 marked deprecated - Main resources
- Labor 27Inventory 19Loyalty 18Terminal 15Catalog 14Customers 14Bookings 13Subscriptions 12Team 12BookingCustomAttributes 11
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Square's published OpenAPI description (square/connect-api-specification) (Apache-2.0)
How to test the Square in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Square collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 60 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “RevokeToken” (POST /oauth2/revoke), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Square?
Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management. It is listed under Payments and has 332 endpoints.
Who publishes the Square?
It is listed from Square's public API description (an OpenAPI document), not published by Square on Swastik Codes. Anyone who controls squareup.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Square?
Requests go to https://connect.squareup.com. Endpoint paths are added to this base URL.
How do I authenticate with the Square?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 60 scopes; an API key in the Authorization header.
How many endpoints does the Square have?
332 operations on 253 paths (148 POST, 121 GET, 36 PUT, 27 DELETE). The largest groups are Labor, Inventory, Loyalty, Terminal.
Is forking the Square free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.