Business — entry 016 of 19
Square
Square's Connect REST API (`connect.squareup.com/v2`) covers payments, refunds, checkout, orders, and point-of-sale/inventory management for merchants on the Square platform. A live GET against `/v2/locations` with no credentials returned a 401 `AUTHENTICATION_ERROR`/`UNAUTHORIZED` JSON error, reconfirming OAuth-token auth; the same request repeated with an `Origin` header, plus a separate OPTIONS preflight (which itself 405s, since the endpoint doesn't support OPTIONS), returned no `access-control-allow-origin` header either way, resolving `cors` unknown -> no. Square's developer portal exposes a free sandbox environment for building and testing integrations, while live production usage is billed per transaction rather than a subscription.
AuthenticationOAuthRequires an OAuth flow; expect app registration.
HTTPSSupportedTraffic is encrypted in transit.
CORSDisabledBrowser calls need a server-side proxy.
PricingMeteredBilled per request beyond a limited free quota.
FormatsJSONResponses can be requested as JSON.
GreatAPIs Score
Score68
Authentication8/25OAuth flow required
Pricing11/20Metered / usage-based pricing
Docs20/20Machine-readable spec file bundled
Formats9/15Single response format
Freshness20/20Verified within 6 months
Embed this badge
<a href="https://greatapis.com/api/square/"><img src="https://greatapis.com/badge/square.svg" alt="Scored 68 on greatapis.com"></a>Auth quickstart
- Register an app / run the OAuth flow to obtain a bearer token.
- Send it as an Authorization header
Authorization: Bearer <token>
Stored keyNo key stored
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
ApplePay1
POST/v2/apple-pay/domainsRegisterDomain
Request body
application/json — RegisterDomainRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RegisterDomainResponse |
BankAccounts5
GET/v2/bank-accountsListBankAccounts
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
limit | query | no | integer |
location_id | query | no | string |
customer_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListBankAccountsResponse |
POST/v2/bank-accountsCreateBankAccount
Request body
application/json — CreateBankAccountRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateBankAccountResponse |
GET/v2/bank-accounts/by-v1-id/{v1_bank_account_id}GetBankAccountByV1Id
Parameters
| Name | In | Required | Type |
|---|---|---|---|
v1_bank_account_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetBankAccountByV1IdResponse |
GET/v2/bank-accounts/{bank_account_id}GetBankAccount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
bank_account_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetBankAccountResponse |
POST/v2/bank-accounts/{bank_account_id}/disableDisableBankAccount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
bank_account_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DisableBankAccountResponse |
BookingCustomAttributes11
GET/v2/bookings/custom-attribute-definitionsListBookingCustomAttributeDefinitions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListBookingCustomAttributeDefinitionsResponse |
POST/v2/bookings/custom-attribute-definitionsCreateBookingCustomAttributeDefinition
Request body
application/json — CreateBookingCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateBookingCustomAttributeDefinitionResponse |
GET/v2/bookings/custom-attribute-definitions/{key}RetrieveBookingCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveBookingCustomAttributeDefinitionResponse |
PUT/v2/bookings/custom-attribute-definitions/{key}UpdateBookingCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Request body
application/json — UpdateBookingCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateBookingCustomAttributeDefinitionResponse |
DELETE/v2/bookings/custom-attribute-definitions/{key}DeleteBookingCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteBookingCustomAttributeDefinitionResponse |
POST/v2/bookings/custom-attributes/bulk-deleteBulkDeleteBookingCustomAttributes
Request body
application/json — BulkDeleteBookingCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkDeleteBookingCustomAttributesResponse |
POST/v2/bookings/custom-attributes/bulk-upsertBulkUpsertBookingCustomAttributes
Request body
application/json — BulkUpsertBookingCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpsertBookingCustomAttributesResponse |
GET/v2/bookings/{booking_id}/custom-attributesListBookingCustomAttributes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
limit | query | no | integer |
cursor | query | no | string |
with_definitions | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListBookingCustomAttributesResponse |
GET/v2/bookings/{booking_id}/custom-attributes/{key}RetrieveBookingCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
key | path | yes | string |
with_definition | query | no | boolean |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveBookingCustomAttributeResponse |
PUT/v2/bookings/{booking_id}/custom-attributes/{key}UpsertBookingCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
key | path | yes | string |
Request body
application/json — UpsertBookingCustomAttributeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertBookingCustomAttributeResponse |
DELETE/v2/bookings/{booking_id}/custom-attributes/{key}DeleteBookingCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteBookingCustomAttributeResponse |
Bookings13
GET/v2/bookingsListBookings
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
cursor | query | no | string |
customer_id | query | no | string |
team_member_id | query | no | string |
location_id | query | no | string |
start_at_min | query | no | string |
start_at_max | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListBookingsResponse |
POST/v2/bookingsCreateBooking
Request body
application/json — CreateBookingRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateBookingResponse |
POST/v2/bookings/availability/searchSearchAvailability
Request body
application/json — SearchAvailabilityRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchAvailabilityResponse |
POST/v2/bookings/bulk-retrieveBulkRetrieveBookings
Request body
application/json — BulkRetrieveBookingsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkRetrieveBookingsResponse |
GET/v2/bookings/business-booking-profileRetrieveBusinessBookingProfile
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveBusinessBookingProfileResponse |
GET/v2/bookings/location-booking-profilesListLocationBookingProfiles
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLocationBookingProfilesResponse |
GET/v2/bookings/location-booking-profiles/{location_id}RetrieveLocationBookingProfile
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLocationBookingProfileResponse |
GET/v2/bookings/team-member-booking-profilesListTeamMemberBookingProfiles
Parameters
| Name | In | Required | Type |
|---|---|---|---|
bookable_only | query | no | boolean |
limit | query | no | integer |
cursor | query | no | string |
location_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListTeamMemberBookingProfilesResponse |
POST/v2/bookings/team-member-booking-profiles/bulk-retrieveBulkRetrieveTeamMemberBookingProfiles
Request body
application/json — BulkRetrieveTeamMemberBookingProfilesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkRetrieveTeamMemberBookingProfilesResponse |
GET/v2/bookings/team-member-booking-profiles/{team_member_id}RetrieveTeamMemberBookingProfile
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTeamMemberBookingProfileResponse |
GET/v2/bookings/{booking_id}RetrieveBooking
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveBookingResponse |
PUT/v2/bookings/{booking_id}UpdateBooking
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
Request body
application/json — UpdateBookingRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateBookingResponse |
POST/v2/bookings/{booking_id}/cancelCancelBooking
Parameters
| Name | In | Required | Type |
|---|---|---|---|
booking_id | path | yes | string |
Request body
application/json — CancelBookingRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelBookingResponse |
Cards4
GET/v2/cardsListCards
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
customer_id | query | no | string |
include_disabled | query | no | boolean |
reference_id | query | no | string |
sort_order | query | no | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCardsResponse |
POST/v2/cardsCreateCard
Request body
application/json — CreateCardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCardResponse |
GET/v2/cards/{card_id}RetrieveCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
card_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCardResponse |
POST/v2/cards/{card_id}/disableDisableCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
card_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DisableCardResponse |
CashDrawers3
GET/v2/cash-drawers/shiftsListCashDrawerShifts
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | yes | string |
sort_order | query | no | — |
begin_time | query | no | string |
end_time | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCashDrawerShiftsResponse |
GET/v2/cash-drawers/shifts/{shift_id}RetrieveCashDrawerShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | yes | string |
shift_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCashDrawerShiftResponse |
GET/v2/cash-drawers/shifts/{shift_id}/eventsListCashDrawerShiftEvents
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | yes | string |
shift_id | path | yes | string |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCashDrawerShiftEventsResponse |
Catalog14
POST/v2/catalog/batch-deleteBatchDeleteCatalogObjects
Request body
application/json — BatchDeleteCatalogObjectsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchDeleteCatalogObjectsResponse |
POST/v2/catalog/batch-retrieveBatchRetrieveCatalogObjects
Request body
application/json — BatchRetrieveCatalogObjectsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveCatalogObjectsResponse |
POST/v2/catalog/batch-upsertBatchUpsertCatalogObjects
Request body
application/json — BatchUpsertCatalogObjectsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchUpsertCatalogObjectsResponse |
POST/v2/catalog/imagesCreateCatalogImage
Request body
multipart/form-data (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCatalogImageResponse |
PUT/v2/catalog/images/{image_id}UpdateCatalogImage
Parameters
| Name | In | Required | Type |
|---|---|---|---|
image_id | path | yes | string |
Request body
multipart/form-data (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateCatalogImageResponse |
GET/v2/catalog/infoCatalogInfo
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CatalogInfoResponse |
GET/v2/catalog/listListCatalog
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
types | query | no | string |
catalog_version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCatalogResponse |
POST/v2/catalog/objectUpsertCatalogObject
Request body
application/json — UpsertCatalogObjectRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertCatalogObjectResponse |
GET/v2/catalog/object/{object_id}RetrieveCatalogObject
Parameters
| Name | In | Required | Type |
|---|---|---|---|
object_id | path | yes | string |
include_related_objects | query | no | boolean |
catalog_version | query | no | integer |
include_category_path_to_root | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCatalogObjectResponse |
DELETE/v2/catalog/object/{object_id}DeleteCatalogObject
Parameters
| Name | In | Required | Type |
|---|---|---|---|
object_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCatalogObjectResponse |
POST/v2/catalog/searchSearchCatalogObjects
Request body
application/json — SearchCatalogObjectsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchCatalogObjectsResponse |
POST/v2/catalog/search-catalog-itemsSearchCatalogItems
Request body
application/json — SearchCatalogItemsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchCatalogItemsResponse |
POST/v2/catalog/update-item-modifier-listsUpdateItemModifierLists
Request body
application/json — UpdateItemModifierListsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateItemModifierListsResponse |
POST/v2/catalog/update-item-taxesUpdateItemTaxes
Request body
application/json — UpdateItemTaxesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateItemTaxesResponse |
Channels3
GET/v2/channelsListChannels
Parameters
| Name | In | Required | Type |
|---|---|---|---|
reference_type | query | no | — |
reference_id | query | no | string |
status | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListChannelsResponse |
POST/v2/channels/bulk-retrieveBulkRetrieveChannels
Request body
application/json — BulkRetrieveChannelsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkRetrieveChannelsResponse |
GET/v2/channels/{channel_id}RetrieveChannel
Parameters
| Name | In | Required | Type |
|---|---|---|---|
channel_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveChannelResponse |
Checkout10
POST/v2/locations/{location_id}/checkoutsCreateCheckout
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Request body
application/json — CreateCheckoutRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCheckoutResponse |
GET/v2/online-checkout/location-settings/{location_id}RetrieveLocationSettings
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLocationSettingsResponse |
PUT/v2/online-checkout/location-settings/{location_id}UpdateLocationSettings
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Request body
application/json — UpdateLocationSettingsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateLocationSettingsResponse |
GET/v2/online-checkout/merchant-settingsRetrieveMerchantSettings
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveMerchantSettingsResponse |
PUT/v2/online-checkout/merchant-settingsUpdateMerchantSettings
Request body
application/json — UpdateMerchantSettingsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateMerchantSettingsResponse |
GET/v2/online-checkout/payment-linksListPaymentLinks
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListPaymentLinksResponse |
POST/v2/online-checkout/payment-linksCreatePaymentLink
Request body
application/json — CreatePaymentLinkRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreatePaymentLinkResponse |
GET/v2/online-checkout/payment-links/{id}RetrievePaymentLink
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrievePaymentLinkResponse |
PUT/v2/online-checkout/payment-links/{id}UpdatePaymentLink
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdatePaymentLinkRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdatePaymentLinkResponse |
DELETE/v2/online-checkout/payment-links/{id}DeletePaymentLink
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeletePaymentLinkResponse |
CustomerCustomAttributes10
GET/v2/customers/custom-attribute-definitionsListCustomerCustomAttributeDefinitions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCustomerCustomAttributeDefinitionsResponse |
POST/v2/customers/custom-attribute-definitionsCreateCustomerCustomAttributeDefinition
Request body
application/json — CreateCustomerCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCustomerCustomAttributeDefinitionResponse |
GET/v2/customers/custom-attribute-definitions/{key}RetrieveCustomerCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCustomerCustomAttributeDefinitionResponse |
PUT/v2/customers/custom-attribute-definitions/{key}UpdateCustomerCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Request body
application/json — UpdateCustomerCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateCustomerCustomAttributeDefinitionResponse |
DELETE/v2/customers/custom-attribute-definitions/{key}DeleteCustomerCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCustomerCustomAttributeDefinitionResponse |
POST/v2/customers/custom-attributes/bulk-upsertBulkUpsertCustomerCustomAttributes
Request body
application/json — BulkUpsertCustomerCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpsertCustomerCustomAttributesResponse |
GET/v2/customers/{customer_id}/custom-attributesListCustomerCustomAttributes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
limit | query | no | integer |
cursor | query | no | string |
with_definitions | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCustomerCustomAttributesResponse |
GET/v2/customers/{customer_id}/custom-attributes/{key}RetrieveCustomerCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
key | path | yes | string |
with_definition | query | no | boolean |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCustomerCustomAttributeResponse |
POST/v2/customers/{customer_id}/custom-attributes/{key}UpsertCustomerCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
key | path | yes | string |
Request body
application/json — UpsertCustomerCustomAttributeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertCustomerCustomAttributeResponse |
DELETE/v2/customers/{customer_id}/custom-attributes/{key}DeleteCustomerCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCustomerCustomAttributeResponse |
CustomerGroups5
GET/v2/customers/groupsListCustomerGroups
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCustomerGroupsResponse |
POST/v2/customers/groupsCreateCustomerGroup
Request body
application/json — CreateCustomerGroupRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCustomerGroupResponse |
GET/v2/customers/groups/{group_id}RetrieveCustomerGroup
Parameters
| Name | In | Required | Type |
|---|---|---|---|
group_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCustomerGroupResponse |
PUT/v2/customers/groups/{group_id}UpdateCustomerGroup
Parameters
| Name | In | Required | Type |
|---|---|---|---|
group_id | path | yes | string |
Request body
application/json — UpdateCustomerGroupRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateCustomerGroupResponse |
DELETE/v2/customers/groups/{group_id}DeleteCustomerGroup
Parameters
| Name | In | Required | Type |
|---|---|---|---|
group_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCustomerGroupResponse |
CustomerSegments2
GET/v2/customers/segmentsListCustomerSegments
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCustomerSegmentsResponse |
GET/v2/customers/segments/{segment_id}RetrieveCustomerSegment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
segment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCustomerSegmentResponse |
Customers14
GET/v2/customersListCustomers
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
limit | query | no | integer |
sort_field | query | no | — |
sort_order | query | no | — |
count | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListCustomersResponse |
POST/v2/customersCreateCustomer
Request body
application/json — CreateCustomerRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCustomerResponse |
POST/v2/customers/bulk-createBulkCreateCustomers
Request body
application/json — BulkCreateCustomersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkCreateCustomersResponse |
POST/v2/customers/bulk-deleteBulkDeleteCustomers
Request body
application/json — BulkDeleteCustomersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkDeleteCustomersResponse |
POST/v2/customers/bulk-retrieveBulkRetrieveCustomers
Request body
application/json — BulkRetrieveCustomersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkRetrieveCustomersResponse |
POST/v2/customers/bulk-updateBulkUpdateCustomers
Request body
application/json — BulkUpdateCustomersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpdateCustomersResponse |
POST/v2/customers/searchSearchCustomers
Request body
application/json — SearchCustomersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchCustomersResponse |
GET/v2/customers/{customer_id}RetrieveCustomer
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveCustomerResponse |
PUT/v2/customers/{customer_id}UpdateCustomer
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
Request body
application/json — UpdateCustomerRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateCustomerResponse |
DELETE/v2/customers/{customer_id}DeleteCustomer
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCustomerResponse |
POST/v2/customers/{customer_id}/cardsCreateCustomerCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
Request body
application/json — CreateCustomerCardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateCustomerCardResponse |
DELETE/v2/customers/{customer_id}/cards/{card_id}DeleteCustomerCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
card_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteCustomerCardResponse |
PUT/v2/customers/{customer_id}/groups/{group_id}AddGroupToCustomer
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
group_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | AddGroupToCustomerResponse |
DELETE/v2/customers/{customer_id}/groups/{group_id}RemoveGroupFromCustomer
Parameters
| Name | In | Required | Type |
|---|---|---|---|
customer_id | path | yes | string |
group_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RemoveGroupFromCustomerResponse |
Devices5
GET/v2/devicesListDevices
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
sort_order | query | no | — |
limit | query | no | integer |
location_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListDevicesResponse |
GET/v2/devices/codesListDeviceCodes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
location_id | query | no | string |
product_type | query | no | — |
status | query | no | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListDeviceCodesResponse |
POST/v2/devices/codesCreateDeviceCode
Request body
application/json — CreateDeviceCodeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateDeviceCodeResponse |
GET/v2/devices/codes/{id}GetDeviceCode
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetDeviceCodeResponse |
GET/v2/devices/{device_id}GetDevice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
device_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetDeviceResponse |
Disputes9
GET/v2/disputesListDisputes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
states | query | no | — |
location_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListDisputesResponse |
GET/v2/disputes/{dispute_id}RetrieveDispute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveDisputeResponse |
POST/v2/disputes/{dispute_id}/acceptAcceptDispute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | AcceptDisputeResponse |
GET/v2/disputes/{dispute_id}/evidenceListDisputeEvidence
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListDisputeEvidenceResponse |
POST/v2/disputes/{dispute_id}/evidence-filesCreateDisputeEvidenceFile
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
Request body
multipart/form-data (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateDisputeEvidenceFileResponse |
POST/v2/disputes/{dispute_id}/evidence-textCreateDisputeEvidenceText
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
Request body
application/json — CreateDisputeEvidenceTextRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateDisputeEvidenceTextResponse |
GET/v2/disputes/{dispute_id}/evidence/{evidence_id}RetrieveDisputeEvidence
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
evidence_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveDisputeEvidenceResponse |
DELETE/v2/disputes/{dispute_id}/evidence/{evidence_id}DeleteDisputeEvidence
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
evidence_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteDisputeEvidenceResponse |
POST/v2/disputes/{dispute_id}/submit-evidenceSubmitEvidence
Parameters
| Name | In | Required | Type |
|---|---|---|---|
dispute_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SubmitEvidenceResponse |
Employees2
GET/v2/employeesListEmployees
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | no | string |
status | query | no | — |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListEmployeesResponse |
GET/v2/employees/{id}RetrieveEmployee
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveEmployeeResponse |
Events4
POST/v2/eventsSearchEvents
Request body
application/json — SearchEventsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchEventsResponse |
PUT/v2/events/disableDisableEvents
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DisableEventsResponse |
PUT/v2/events/enableEnableEvents
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | EnableEventsResponse |
GET/v2/events/typesListEventTypes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
api_version | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListEventTypesResponse |
GiftCardActivities2
GET/v2/gift-cards/activitiesListGiftCardActivities
Parameters
| Name | In | Required | Type |
|---|---|---|---|
gift_card_id | query | no | string |
type | query | no | string |
location_id | query | no | string |
begin_time | query | no | string |
end_time | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
sort_order | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListGiftCardActivitiesResponse |
POST/v2/gift-cards/activitiesCreateGiftCardActivity
Request body
application/json — CreateGiftCardActivityRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateGiftCardActivityResponse |
GiftCards7
GET/v2/gift-cardsListGiftCards
Parameters
| Name | In | Required | Type |
|---|---|---|---|
type | query | no | string |
state | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
customer_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListGiftCardsResponse |
POST/v2/gift-cardsCreateGiftCard
Request body
application/json — CreateGiftCardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateGiftCardResponse |
POST/v2/gift-cards/from-ganRetrieveGiftCardFromGAN
Request body
application/json — RetrieveGiftCardFromGANRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveGiftCardFromGANResponse |
POST/v2/gift-cards/from-nonceRetrieveGiftCardFromNonce
Request body
application/json — RetrieveGiftCardFromNonceRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveGiftCardFromNonceResponse |
POST/v2/gift-cards/{gift_card_id}/link-customerLinkCustomerToGiftCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
gift_card_id | path | yes | string |
Request body
application/json — LinkCustomerToGiftCardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | LinkCustomerToGiftCardResponse |
POST/v2/gift-cards/{gift_card_id}/unlink-customerUnlinkCustomerFromGiftCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
gift_card_id | path | yes | string |
Request body
application/json — UnlinkCustomerFromGiftCardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UnlinkCustomerFromGiftCardResponse |
GET/v2/gift-cards/{id}RetrieveGiftCard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveGiftCardResponse |
Inventory19
GET/v2/inventory/adjustment-reasonsListInventoryAdjustmentReasons
Parameters
| Name | In | Required | Type |
|---|---|---|---|
include_deleted | query | no | boolean |
include_system_codes | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListInventoryAdjustmentReasonsResponse |
POST/v2/inventory/adjustment-reasons/createCreateInventoryAdjustmentReason
Request body
application/json — CreateInventoryAdjustmentReasonRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateInventoryAdjustmentReasonResponse |
POST/v2/inventory/adjustment-reasons/deleteDeleteInventoryAdjustmentReason
Request body
application/json — DeleteInventoryAdjustmentReasonRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteInventoryAdjustmentReasonResponse |
POST/v2/inventory/adjustment-reasons/restoreRestoreInventoryAdjustmentReason
Request body
application/json — RestoreInventoryAdjustmentReasonRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RestoreInventoryAdjustmentReasonResponse |
POST/v2/inventory/adjustment-reasons/retrieveRetrieveInventoryAdjustmentReason
Request body
application/json — RetrieveInventoryAdjustmentReasonRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryAdjustmentReasonResponse |
PUT/v2/inventory/adjustment-reasons/updateUpdateInventoryAdjustmentReason
Request body
application/json — UpdateInventoryAdjustmentReasonRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateInventoryAdjustmentReasonResponse |
GET/v2/inventory/adjustment/{adjustment_id}DeprecatedRetrieveInventoryAdjustment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
adjustment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryAdjustmentResponse |
PUT/v2/inventory/adjustments/updateUpdateInventoryAdjustment
Request body
application/json — UpdateInventoryAdjustmentRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateInventoryAdjustmentResponse |
GET/v2/inventory/adjustments/{adjustment_id}RetrieveInventoryAdjustment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
adjustment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryAdjustmentResponse |
POST/v2/inventory/batch-changeDeprecatedBatchChangeInventory
Request body
application/json — BatchChangeInventoryRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchChangeInventoryResponse |
POST/v2/inventory/batch-retrieve-changesDeprecatedBatchRetrieveInventoryChanges
Request body
application/json — BatchRetrieveInventoryChangesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveInventoryChangesResponse |
POST/v2/inventory/batch-retrieve-countsDeprecatedBatchRetrieveInventoryCounts
Request body
application/json — BatchRetrieveInventoryCountsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveInventoryCountsResponse |
POST/v2/inventory/changes/batch-createBatchChangeInventory
Request body
application/json — BatchChangeInventoryRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchChangeInventoryResponse |
POST/v2/inventory/changes/batch-retrieveBatchRetrieveInventoryChanges
Request body
application/json — BatchRetrieveInventoryChangesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveInventoryChangesResponse |
POST/v2/inventory/counts/batch-retrieveBatchRetrieveInventoryCounts
Request body
application/json — BatchRetrieveInventoryCountsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveInventoryCountsResponse |
GET/v2/inventory/physical-count/{physical_count_id}DeprecatedRetrieveInventoryPhysicalCount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
physical_count_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryPhysicalCountResponse |
GET/v2/inventory/physical-counts/{physical_count_id}RetrieveInventoryPhysicalCount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
physical_count_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryPhysicalCountResponse |
GET/v2/inventory/{catalog_object_id}RetrieveInventoryCount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
catalog_object_id | path | yes | string |
location_ids | query | no | string |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryCountResponse |
GET/v2/inventory/{catalog_object_id}/changesRetrieveInventoryChanges
Parameters
| Name | In | Required | Type |
|---|---|---|---|
catalog_object_id | path | yes | string |
location_ids | query | no | string |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveInventoryChangesResponse |
Invoices10
GET/v2/invoicesListInvoices
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | yes | string |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListInvoicesResponse |
POST/v2/invoicesCreateInvoice
Request body
application/json — CreateInvoiceRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateInvoiceResponse |
POST/v2/invoices/searchSearchInvoices
Request body
application/json — SearchInvoicesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchInvoicesResponse |
GET/v2/invoices/{invoice_id}GetInvoice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetInvoiceResponse |
PUT/v2/invoices/{invoice_id}UpdateInvoice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
Request body
application/json — UpdateInvoiceRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateInvoiceResponse |
DELETE/v2/invoices/{invoice_id}DeleteInvoice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteInvoiceResponse |
POST/v2/invoices/{invoice_id}/attachmentsCreateInvoiceAttachment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
Request body
multipart/form-data (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateInvoiceAttachmentResponse |
DELETE/v2/invoices/{invoice_id}/attachments/{attachment_id}DeleteInvoiceAttachment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
attachment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteInvoiceAttachmentResponse |
POST/v2/invoices/{invoice_id}/cancelCancelInvoice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
Request body
application/json — CancelInvoiceRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelInvoiceResponse |
POST/v2/invoices/{invoice_id}/publishPublishInvoice
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invoice_id | path | yes | string |
Request body
application/json — PublishInvoiceRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | PublishInvoiceResponse |
Labor27
GET/v2/labor/break-typesListBreakTypes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListBreakTypesResponse |
POST/v2/labor/break-typesCreateBreakType
Request body
application/json — CreateBreakTypeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateBreakTypeResponse |
GET/v2/labor/break-types/{id}GetBreakType
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetBreakTypeResponse |
PUT/v2/labor/break-types/{id}UpdateBreakType
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdateBreakTypeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateBreakTypeResponse |
DELETE/v2/labor/break-types/{id}DeleteBreakType
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteBreakTypeResponse |
GET/v2/labor/employee-wagesListEmployeeWages
Parameters
| Name | In | Required | Type |
|---|---|---|---|
employee_id | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListEmployeeWagesResponse |
GET/v2/labor/employee-wages/{id}GetEmployeeWage
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetEmployeeWageResponse |
POST/v2/labor/scheduled-shiftsCreateScheduledShift
Request body
application/json — CreateScheduledShiftRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateScheduledShiftResponse |
POST/v2/labor/scheduled-shifts/bulk-publishBulkPublishScheduledShifts
Request body
application/json — BulkPublishScheduledShiftsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkPublishScheduledShiftsResponse |
POST/v2/labor/scheduled-shifts/searchSearchScheduledShifts
Request body
application/json — SearchScheduledShiftsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchScheduledShiftsResponse |
GET/v2/labor/scheduled-shifts/{id}RetrieveScheduledShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveScheduledShiftResponse |
PUT/v2/labor/scheduled-shifts/{id}UpdateScheduledShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdateScheduledShiftRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateScheduledShiftResponse |
POST/v2/labor/scheduled-shifts/{id}/publishPublishScheduledShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — PublishScheduledShiftRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | PublishScheduledShiftResponse |
POST/v2/labor/shiftsCreateShift
Request body
application/json — CreateShiftRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateShiftResponse |
POST/v2/labor/shifts/searchSearchShifts
Request body
application/json — SearchShiftsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchShiftsResponse |
GET/v2/labor/shifts/{id}GetShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetShiftResponse |
PUT/v2/labor/shifts/{id}UpdateShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdateShiftRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateShiftResponse |
DELETE/v2/labor/shifts/{id}DeleteShift
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteShiftResponse |
GET/v2/labor/team-member-wagesListTeamMemberWages
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | query | no | string |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListTeamMemberWagesResponse |
GET/v2/labor/team-member-wages/{id}GetTeamMemberWage
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetTeamMemberWageResponse |
POST/v2/labor/timecardsCreateTimecard
Request body
application/json — CreateTimecardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTimecardResponse |
POST/v2/labor/timecards/searchSearchTimecards
Request body
application/json — SearchTimecardsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTimecardsResponse |
GET/v2/labor/timecards/{id}RetrieveTimecard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTimecardResponse |
PUT/v2/labor/timecards/{id}UpdateTimecard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdateTimecardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateTimecardResponse |
DELETE/v2/labor/timecards/{id}DeleteTimecard
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteTimecardResponse |
GET/v2/labor/workweek-configsListWorkweekConfigs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListWorkweekConfigsResponse |
PUT/v2/labor/workweek-configs/{id}UpdateWorkweekConfig
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json — UpdateWorkweekConfigRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateWorkweekConfigResponse |
LocationCustomAttributes11
GET/v2/locations/custom-attribute-definitionsListLocationCustomAttributeDefinitions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
visibility_filter | query | no | — |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLocationCustomAttributeDefinitionsResponse |
POST/v2/locations/custom-attribute-definitionsCreateLocationCustomAttributeDefinition
Request body
application/json — CreateLocationCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateLocationCustomAttributeDefinitionResponse |
GET/v2/locations/custom-attribute-definitions/{key}RetrieveLocationCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLocationCustomAttributeDefinitionResponse |
PUT/v2/locations/custom-attribute-definitions/{key}UpdateLocationCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Request body
application/json — UpdateLocationCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateLocationCustomAttributeDefinitionResponse |
DELETE/v2/locations/custom-attribute-definitions/{key}DeleteLocationCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteLocationCustomAttributeDefinitionResponse |
POST/v2/locations/custom-attributes/bulk-deleteBulkDeleteLocationCustomAttributes
Request body
application/json — BulkDeleteLocationCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkDeleteLocationCustomAttributesResponse |
POST/v2/locations/custom-attributes/bulk-upsertBulkUpsertLocationCustomAttributes
Request body
application/json — BulkUpsertLocationCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpsertLocationCustomAttributesResponse |
GET/v2/locations/{location_id}/custom-attributesListLocationCustomAttributes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
visibility_filter | query | no | — |
limit | query | no | integer |
cursor | query | no | string |
with_definitions | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLocationCustomAttributesResponse |
GET/v2/locations/{location_id}/custom-attributes/{key}RetrieveLocationCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
key | path | yes | string |
with_definition | query | no | boolean |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLocationCustomAttributeResponse |
POST/v2/locations/{location_id}/custom-attributes/{key}UpsertLocationCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
key | path | yes | string |
Request body
application/json — UpsertLocationCustomAttributeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertLocationCustomAttributeResponse |
DELETE/v2/locations/{location_id}/custom-attributes/{key}DeleteLocationCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteLocationCustomAttributeResponse |
Locations4
GET/v2/locationsListLocations
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLocationsResponse |
POST/v2/locationsCreateLocation
Request body
application/json — CreateLocationRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateLocationResponse |
GET/v2/locations/{location_id}RetrieveLocation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLocationResponse |
PUT/v2/locations/{location_id}UpdateLocation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
Request body
application/json — UpdateLocationRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateLocationResponse |
Loyalty18
POST/v2/loyalty/accountsCreateLoyaltyAccount
Request body
application/json — CreateLoyaltyAccountRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateLoyaltyAccountResponse |
POST/v2/loyalty/accounts/searchSearchLoyaltyAccounts
Request body
application/json — SearchLoyaltyAccountsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchLoyaltyAccountsResponse |
GET/v2/loyalty/accounts/{account_id}RetrieveLoyaltyAccount
Parameters
| Name | In | Required | Type |
|---|---|---|---|
account_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLoyaltyAccountResponse |
POST/v2/loyalty/accounts/{account_id}/accumulateAccumulateLoyaltyPoints
Parameters
| Name | In | Required | Type |
|---|---|---|---|
account_id | path | yes | string |
Request body
application/json — AccumulateLoyaltyPointsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | AccumulateLoyaltyPointsResponse |
POST/v2/loyalty/accounts/{account_id}/adjustAdjustLoyaltyPoints
Parameters
| Name | In | Required | Type |
|---|---|---|---|
account_id | path | yes | string |
Request body
application/json — AdjustLoyaltyPointsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | AdjustLoyaltyPointsResponse |
POST/v2/loyalty/events/searchSearchLoyaltyEvents
Request body
application/json — SearchLoyaltyEventsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchLoyaltyEventsResponse |
GET/v2/loyalty/programsListLoyaltyPrograms
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLoyaltyProgramsResponse |
GET/v2/loyalty/programs/{program_id}RetrieveLoyaltyProgram
Parameters
| Name | In | Required | Type |
|---|---|---|---|
program_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLoyaltyProgramResponse |
POST/v2/loyalty/programs/{program_id}/calculateCalculateLoyaltyPoints
Parameters
| Name | In | Required | Type |
|---|---|---|---|
program_id | path | yes | string |
Request body
application/json — CalculateLoyaltyPointsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CalculateLoyaltyPointsResponse |
GET/v2/loyalty/programs/{program_id}/promotionsListLoyaltyPromotions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
program_id | path | yes | string |
status | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListLoyaltyPromotionsResponse |
POST/v2/loyalty/programs/{program_id}/promotionsCreateLoyaltyPromotion
Parameters
| Name | In | Required | Type |
|---|---|---|---|
program_id | path | yes | string |
Request body
application/json — CreateLoyaltyPromotionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateLoyaltyPromotionResponse |
GET/v2/loyalty/programs/{program_id}/promotions/{promotion_id}RetrieveLoyaltyPromotion
Parameters
| Name | In | Required | Type |
|---|---|---|---|
promotion_id | path | yes | string |
program_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLoyaltyPromotionResponse |
POST/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancelCancelLoyaltyPromotion
Parameters
| Name | In | Required | Type |
|---|---|---|---|
promotion_id | path | yes | string |
program_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelLoyaltyPromotionResponse |
POST/v2/loyalty/rewardsCreateLoyaltyReward
Request body
application/json — CreateLoyaltyRewardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateLoyaltyRewardResponse |
POST/v2/loyalty/rewards/searchSearchLoyaltyRewards
Request body
application/json — SearchLoyaltyRewardsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchLoyaltyRewardsResponse |
GET/v2/loyalty/rewards/{reward_id}RetrieveLoyaltyReward
Parameters
| Name | In | Required | Type |
|---|---|---|---|
reward_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveLoyaltyRewardResponse |
DELETE/v2/loyalty/rewards/{reward_id}DeleteLoyaltyReward
Parameters
| Name | In | Required | Type |
|---|---|---|---|
reward_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteLoyaltyRewardResponse |
POST/v2/loyalty/rewards/{reward_id}/redeemRedeemLoyaltyReward
Parameters
| Name | In | Required | Type |
|---|---|---|---|
reward_id | path | yes | string |
Request body
application/json — RedeemLoyaltyRewardRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RedeemLoyaltyRewardResponse |
MerchantCustomAttributes11
GET/v2/merchants/custom-attribute-definitionsListMerchantCustomAttributeDefinitions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
visibility_filter | query | no | — |
limit | query | no | integer |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListMerchantCustomAttributeDefinitionsResponse |
POST/v2/merchants/custom-attribute-definitionsCreateMerchantCustomAttributeDefinition
Request body
application/json — CreateMerchantCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateMerchantCustomAttributeDefinitionResponse |
GET/v2/merchants/custom-attribute-definitions/{key}RetrieveMerchantCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveMerchantCustomAttributeDefinitionResponse |
PUT/v2/merchants/custom-attribute-definitions/{key}UpdateMerchantCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Request body
application/json — UpdateMerchantCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateMerchantCustomAttributeDefinitionResponse |
DELETE/v2/merchants/custom-attribute-definitions/{key}DeleteMerchantCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteMerchantCustomAttributeDefinitionResponse |
POST/v2/merchants/custom-attributes/bulk-deleteBulkDeleteMerchantCustomAttributes
Request body
application/json — BulkDeleteMerchantCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkDeleteMerchantCustomAttributesResponse |
POST/v2/merchants/custom-attributes/bulk-upsertBulkUpsertMerchantCustomAttributes
Request body
application/json — BulkUpsertMerchantCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpsertMerchantCustomAttributesResponse |
GET/v2/merchants/{merchant_id}/custom-attributesListMerchantCustomAttributes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
merchant_id | path | yes | string |
visibility_filter | query | no | — |
limit | query | no | integer |
cursor | query | no | string |
with_definitions | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListMerchantCustomAttributesResponse |
GET/v2/merchants/{merchant_id}/custom-attributes/{key}RetrieveMerchantCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
merchant_id | path | yes | string |
key | path | yes | string |
with_definition | query | no | boolean |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveMerchantCustomAttributeResponse |
POST/v2/merchants/{merchant_id}/custom-attributes/{key}UpsertMerchantCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
merchant_id | path | yes | string |
key | path | yes | string |
Request body
application/json — UpsertMerchantCustomAttributeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertMerchantCustomAttributeResponse |
DELETE/v2/merchants/{merchant_id}/custom-attributes/{key}DeleteMerchantCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
merchant_id | path | yes | string |
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteMerchantCustomAttributeResponse |
Merchants2
GET/v2/merchantsListMerchants
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListMerchantsResponse |
GET/v2/merchants/{merchant_id}RetrieveMerchant
Parameters
| Name | In | Required | Type |
|---|---|---|---|
merchant_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveMerchantResponse |
OAuth3
POST/oauth2/revokeRevokeToken
Request body
application/json — RevokeTokenRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RevokeTokenResponse |
POST/oauth2/tokenObtainToken
Request body
application/json — ObtainTokenRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ObtainTokenResponse |
POST/oauth2/token/statusRetrieveTokenStatus
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTokenStatusResponse |
OrderCustomAttributes11
GET/v2/orders/custom-attribute-definitionsListOrderCustomAttributeDefinitions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
visibility_filter | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListOrderCustomAttributeDefinitionsResponse |
POST/v2/orders/custom-attribute-definitionsCreateOrderCustomAttributeDefinition
Request body
application/json — CreateOrderCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateOrderCustomAttributeDefinitionResponse |
GET/v2/orders/custom-attribute-definitions/{key}RetrieveOrderCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveOrderCustomAttributeDefinitionResponse |
PUT/v2/orders/custom-attribute-definitions/{key}UpdateOrderCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Request body
application/json — UpdateOrderCustomAttributeDefinitionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateOrderCustomAttributeDefinitionResponse |
DELETE/v2/orders/custom-attribute-definitions/{key}DeleteOrderCustomAttributeDefinition
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteOrderCustomAttributeDefinitionResponse |
POST/v2/orders/custom-attributes/bulk-deleteBulkDeleteOrderCustomAttributes
Request body
application/json — BulkDeleteOrderCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkDeleteOrderCustomAttributesResponse |
POST/v2/orders/custom-attributes/bulk-upsertBulkUpsertOrderCustomAttributes
Request body
application/json — BulkUpsertOrderCustomAttributesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpsertOrderCustomAttributesResponse |
GET/v2/orders/{order_id}/custom-attributesListOrderCustomAttributes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
visibility_filter | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
with_definitions | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListOrderCustomAttributesResponse |
GET/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}RetrieveOrderCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
custom_attribute_key | path | yes | string |
version | query | no | integer |
with_definition | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveOrderCustomAttributeResponse |
POST/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}UpsertOrderCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
custom_attribute_key | path | yes | string |
Request body
application/json — UpsertOrderCustomAttributeRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertOrderCustomAttributeResponse |
DELETE/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}DeleteOrderCustomAttribute
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
custom_attribute_key | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteOrderCustomAttributeResponse |
Orders8
POST/v2/ordersCreateOrder
Request body
application/json — CreateOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateOrderResponse |
POST/v2/orders/batch-retrieveBatchRetrieveOrders
Request body
application/json — BatchRetrieveOrdersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BatchRetrieveOrdersResponse |
POST/v2/orders/calculateCalculateOrder
Request body
application/json — CalculateOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CalculateOrderResponse |
POST/v2/orders/cloneCloneOrder
Request body
application/json — CloneOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CloneOrderResponse |
POST/v2/orders/searchSearchOrders
Request body
application/json — SearchOrdersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchOrdersResponse |
GET/v2/orders/{order_id}RetrieveOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveOrderResponse |
PUT/v2/orders/{order_id}UpdateOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
Request body
application/json — UpdateOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateOrderResponse |
POST/v2/orders/{order_id}/payPayOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
order_id | path | yes | string |
Request body
application/json — PayOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | PayOrderResponse |
Payments7
GET/v2/paymentsListPayments
Parameters
| Name | In | Required | Type |
|---|---|---|---|
begin_time | query | no | string |
end_time | query | no | string |
sort_order | query | no | string |
cursor | query | no | string |
location_id | query | no | string |
total | query | no | integer |
last_4 | query | no | string |
card_brand | query | no | string |
limit | query | no | integer |
is_offline_payment | query | no | boolean |
offline_begin_time | query | no | string |
offline_end_time | query | no | string |
updated_at_begin_time | query | no | string |
updated_at_end_time | query | no | string |
sort_field | query | no | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListPaymentsResponse |
POST/v2/paymentsCreatePayment
Request body
application/json — CreatePaymentRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreatePaymentResponse |
POST/v2/payments/cancelCancelPaymentByIdempotencyKey
Request body
application/json — CancelPaymentByIdempotencyKeyRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelPaymentByIdempotencyKeyResponse |
GET/v2/payments/{payment_id}GetPayment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetPaymentResponse |
PUT/v2/payments/{payment_id}UpdatePayment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payment_id | path | yes | string |
Request body
application/json — UpdatePaymentRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdatePaymentResponse |
POST/v2/payments/{payment_id}/cancelCancelPayment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payment_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelPaymentResponse |
POST/v2/payments/{payment_id}/completeCompletePayment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payment_id | path | yes | string |
Request body
application/json — CompletePaymentRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CompletePaymentResponse |
Payouts3
GET/v2/payoutsListPayouts
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | query | no | string |
status | query | no | — |
begin_time | query | no | string |
end_time | query | no | string |
sort_order | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListPayoutsResponse |
GET/v2/payouts/{payout_id}GetPayout
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payout_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetPayoutResponse |
GET/v2/payouts/{payout_id}/payout-entriesListPayoutEntries
Parameters
| Name | In | Required | Type |
|---|---|---|---|
payout_id | path | yes | string |
sort_order | query | no | — |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListPayoutEntriesResponse |
Refunds3
GET/v2/refundsListPaymentRefunds
Parameters
| Name | In | Required | Type |
|---|---|---|---|
begin_time | query | no | string |
end_time | query | no | string |
sort_order | query | no | string |
cursor | query | no | string |
location_id | query | no | string |
status | query | no | string |
source_type | query | no | string |
limit | query | no | integer |
updated_at_begin_time | query | no | string |
updated_at_end_time | query | no | string |
sort_field | query | no | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListPaymentRefundsResponse |
POST/v2/refundsRefundPayment
Request body
application/json — RefundPaymentRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RefundPaymentResponse |
GET/v2/refunds/{refund_id}GetPaymentRefund
Parameters
| Name | In | Required | Type |
|---|---|---|---|
refund_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetPaymentRefundResponse |
Sites1
GET/v2/sitesListSites
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListSitesResponse |
Snippets3
GET/v2/sites/{site_id}/snippetRetrieveSnippet
Parameters
| Name | In | Required | Type |
|---|---|---|---|
site_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveSnippetResponse |
POST/v2/sites/{site_id}/snippetUpsertSnippet
Parameters
| Name | In | Required | Type |
|---|---|---|---|
site_id | path | yes | string |
Request body
application/json — UpsertSnippetRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpsertSnippetResponse |
DELETE/v2/sites/{site_id}/snippetDeleteSnippet
Parameters
| Name | In | Required | Type |
|---|---|---|---|
site_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteSnippetResponse |
Subscriptions12
POST/v2/subscriptionsCreateSubscription
Request body
application/json — CreateSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateSubscriptionResponse |
POST/v2/subscriptions/bulk-swap-planBulkSwapPlan
Request body
application/json — BulkSwapPlanRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkSwapPlanResponse |
POST/v2/subscriptions/searchSearchSubscriptions
Request body
application/json — SearchSubscriptionsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchSubscriptionsResponse |
GET/v2/subscriptions/{subscription_id}RetrieveSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
include | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveSubscriptionResponse |
PUT/v2/subscriptions/{subscription_id}UpdateSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — UpdateSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateSubscriptionResponse |
DELETE/v2/subscriptions/{subscription_id}/actions/{action_id}DeleteSubscriptionAction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
action_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteSubscriptionActionResponse |
POST/v2/subscriptions/{subscription_id}/billing-anchorChangeBillingAnchorDate
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — ChangeBillingAnchorDateRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ChangeBillingAnchorDateResponse |
POST/v2/subscriptions/{subscription_id}/cancelCancelSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelSubscriptionResponse |
GET/v2/subscriptions/{subscription_id}/eventsListSubscriptionEvents
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
cursor | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListSubscriptionEventsResponse |
POST/v2/subscriptions/{subscription_id}/pausePauseSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — PauseSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | PauseSubscriptionResponse |
POST/v2/subscriptions/{subscription_id}/resumeResumeSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — ResumeSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ResumeSubscriptionResponse |
POST/v2/subscriptions/{subscription_id}/swap-planSwapPlan
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — SwapPlanRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SwapPlanResponse |
Team12
POST/v2/team-membersCreateTeamMember
Request body
application/json — CreateTeamMemberRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTeamMemberResponse |
POST/v2/team-members/bulk-createBulkCreateTeamMembers
Request body
application/json — BulkCreateTeamMembersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkCreateTeamMembersResponse |
POST/v2/team-members/bulk-updateBulkUpdateTeamMembers
Request body
application/json — BulkUpdateTeamMembersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpdateTeamMembersResponse |
GET/v2/team-members/jobsListJobs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListJobsResponse |
POST/v2/team-members/jobsCreateJob
Request body
application/json — CreateJobRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateJobResponse |
GET/v2/team-members/jobs/{job_id}RetrieveJob
Parameters
| Name | In | Required | Type |
|---|---|---|---|
job_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveJobResponse |
PUT/v2/team-members/jobs/{job_id}UpdateJob
Parameters
| Name | In | Required | Type |
|---|---|---|---|
job_id | path | yes | string |
Request body
application/json — UpdateJobRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateJobResponse |
POST/v2/team-members/searchSearchTeamMembers
Request body
application/json — SearchTeamMembersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTeamMembersResponse |
GET/v2/team-members/{team_member_id}RetrieveTeamMember
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTeamMemberResponse |
PUT/v2/team-members/{team_member_id}UpdateTeamMember
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | path | yes | string |
Request body
application/json — UpdateTeamMemberRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateTeamMemberResponse |
GET/v2/team-members/{team_member_id}/wage-settingRetrieveWageSetting
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveWageSettingResponse |
PUT/v2/team-members/{team_member_id}/wage-settingUpdateWageSetting
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_member_id | path | yes | string |
Request body
application/json — UpdateWageSettingRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateWageSettingResponse |
Terminal15
POST/v2/terminals/actionsCreateTerminalAction
Request body
application/json — CreateTerminalActionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTerminalActionResponse |
POST/v2/terminals/actions/searchSearchTerminalActions
Request body
application/json — SearchTerminalActionsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTerminalActionsResponse |
GET/v2/terminals/actions/{action_id}GetTerminalAction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
action_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetTerminalActionResponse |
POST/v2/terminals/actions/{action_id}/cancelCancelTerminalAction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
action_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelTerminalActionResponse |
POST/v2/terminals/actions/{action_id}/dismissDismissTerminalAction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
action_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DismissTerminalActionResponse |
POST/v2/terminals/checkoutsCreateTerminalCheckout
Request body
application/json — CreateTerminalCheckoutRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTerminalCheckoutResponse |
POST/v2/terminals/checkouts/searchSearchTerminalCheckouts
Request body
application/json — SearchTerminalCheckoutsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTerminalCheckoutsResponse |
GET/v2/terminals/checkouts/{checkout_id}GetTerminalCheckout
Parameters
| Name | In | Required | Type |
|---|---|---|---|
checkout_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetTerminalCheckoutResponse |
POST/v2/terminals/checkouts/{checkout_id}/cancelCancelTerminalCheckout
Parameters
| Name | In | Required | Type |
|---|---|---|---|
checkout_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelTerminalCheckoutResponse |
POST/v2/terminals/checkouts/{checkout_id}/dismissDismissTerminalCheckout
Parameters
| Name | In | Required | Type |
|---|---|---|---|
checkout_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DismissTerminalCheckoutResponse |
POST/v2/terminals/refundsCreateTerminalRefund
Request body
application/json — CreateTerminalRefundRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTerminalRefundResponse |
POST/v2/terminals/refunds/searchSearchTerminalRefunds
Request body
application/json — SearchTerminalRefundsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTerminalRefundsResponse |
GET/v2/terminals/refunds/{terminal_refund_id}GetTerminalRefund
Parameters
| Name | In | Required | Type |
|---|---|---|---|
terminal_refund_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | GetTerminalRefundResponse |
POST/v2/terminals/refunds/{terminal_refund_id}/cancelCancelTerminalRefund
Parameters
| Name | In | Required | Type |
|---|---|---|---|
terminal_refund_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelTerminalRefundResponse |
POST/v2/terminals/refunds/{terminal_refund_id}/dismissDismissTerminalRefund
Parameters
| Name | In | Required | Type |
|---|---|---|---|
terminal_refund_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DismissTerminalRefundResponse |
Transactions4
GET/v2/locations/{location_id}/transactionsListTransactions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
begin_time | query | no | string |
end_time | query | no | string |
sort_order | query | no | — |
cursor | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListTransactionsResponse |
GET/v2/locations/{location_id}/transactions/{transaction_id}RetrieveTransaction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
transaction_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTransactionResponse |
POST/v2/locations/{location_id}/transactions/{transaction_id}/captureCaptureTransaction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
transaction_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CaptureTransactionResponse |
POST/v2/locations/{location_id}/transactions/{transaction_id}/voidVoidTransaction
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
transaction_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | VoidTransactionResponse |
TransferOrder8
POST/v2/transfer-ordersCreateTransferOrder
Request body
application/json — CreateTransferOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateTransferOrderResponse |
POST/v2/transfer-orders/searchSearchTransferOrders
Request body
application/json — SearchTransferOrdersRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchTransferOrdersResponse |
GET/v2/transfer-orders/{transfer_order_id}RetrieveTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveTransferOrderResponse |
PUT/v2/transfer-orders/{transfer_order_id}UpdateTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
Request body
application/json — UpdateTransferOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateTransferOrderResponse |
DELETE/v2/transfer-orders/{transfer_order_id}DeleteTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
version | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteTransferOrderResponse |
POST/v2/transfer-orders/{transfer_order_id}/cancelCancelTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
Request body
application/json — CancelTransferOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CancelTransferOrderResponse |
POST/v2/transfer-orders/{transfer_order_id}/receiveReceiveTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
Request body
application/json — ReceiveTransferOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ReceiveTransferOrderResponse |
POST/v2/transfer-orders/{transfer_order_id}/startStartTransferOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
transfer_order_id | path | yes | string |
Request body
application/json — StartTransferOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | StartTransferOrderResponse |
V1Transactions3
GET/v1/{location_id}/ordersV1ListOrders
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
order | query | no | — |
limit | query | no | integer |
batch_token | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/v1/{location_id}/orders/{order_id}V1RetrieveOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
order_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | V1Order |
PUT/v1/{location_id}/orders/{order_id}V1UpdateOrder
Parameters
| Name | In | Required | Type |
|---|---|---|---|
location_id | path | yes | string |
order_id | path | yes | string |
Request body
application/json — V1UpdateOrderRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | V1Order |
Vendors7
POST/v2/vendors/bulk-createBulkCreateVendors
Request body
application/json — BulkCreateVendorsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkCreateVendorsResponse |
POST/v2/vendors/bulk-retrieveBulkRetrieveVendors
Request body
application/json — BulkRetrieveVendorsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkRetrieveVendorsResponse |
PUT/v2/vendors/bulk-updateBulkUpdateVendors
Request body
application/json — BulkUpdateVendorsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | BulkUpdateVendorsResponse |
POST/v2/vendors/createCreateVendor
Request body
application/json — CreateVendorRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateVendorResponse |
POST/v2/vendors/searchSearchVendors
Request body
application/json — SearchVendorsRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | SearchVendorsResponse |
GET/v2/vendors/{vendor_id}RetrieveVendor
Parameters
| Name | In | Required | Type |
|---|---|---|---|
vendor_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveVendorResponse |
PUT/v2/vendors/{vendor_id}UpdateVendor
Request body
application/json — UpdateVendorRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateVendorResponse |
WebhookSubscriptions8
GET/v2/webhooks/event-typesListWebhookEventTypes
Parameters
| Name | In | Required | Type |
|---|---|---|---|
api_version | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListWebhookEventTypesResponse |
GET/v2/webhooks/subscriptionsListWebhookSubscriptions
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
include_disabled | query | no | boolean |
sort_order | query | no | — |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | ListWebhookSubscriptionsResponse |
POST/v2/webhooks/subscriptionsCreateWebhookSubscription
Request body
application/json — CreateWebhookSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | CreateWebhookSubscriptionResponse |
GET/v2/webhooks/subscriptions/{subscription_id}RetrieveWebhookSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | RetrieveWebhookSubscriptionResponse |
PUT/v2/webhooks/subscriptions/{subscription_id}UpdateWebhookSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — UpdateWebhookSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateWebhookSubscriptionResponse |
DELETE/v2/webhooks/subscriptions/{subscription_id}DeleteWebhookSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | DeleteWebhookSubscriptionResponse |
POST/v2/webhooks/subscriptions/{subscription_id}/signature-keyUpdateWebhookSubscriptionSignatureKey
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — UpdateWebhookSubscriptionSignatureKeyRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | UpdateWebhookSubscriptionSignatureKeyResponse |
POST/v2/webhooks/subscriptions/{subscription_id}/testTestWebhookSubscription
Parameters
| Name | In | Required | Type |
|---|---|---|---|
subscription_id | path | yes | string |
Request body
application/json — TestWebhookSubscriptionRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Success | TestWebhookSubscriptionResponse |
Try it
Developer reference
Base URL
https://connect.squareup.comRate limit
Square does not publish a fixed per-endpoint REST QPS; exceeding capacity returns 429 Too Many Requests with a RATE_LIMITED error, and Square recommends retrying with exponential backoff and jitter. The GraphQL API is capped at 10 queries per second with a per-query complexity budget of 250 points (max depth 10), returning COMPLEXITY_MAX_REACHED when a query exceeds the budget.
Key endpoints
- GET/v2/locations
- GET/v2/payments
- POST/v2/payments
- GET/v2/customers
- GET/v2/catalog/list