Client library for accessing the Square Connect APIs
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 2.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://squareup.com/developers
Dart 2.12 or later
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
square_dart_sdk:
git: https://github.com/iwatakeshi/connect-dart-sdk.git
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
square_dart_sdk:
path: /path/to/square_dart_sdk
TODO
Please follow the installation procedure and then run the following:
import 'package:square_dart_sdk/api.dart';
// TODO Configure OAuth2 access token for authorization: oauth2
//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = ApplePayApi();
final body = RegisterDomainRequest(); // RegisterDomainRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
final result = api_instance.registerDomain(body);
print(result);
} catch (e) {
print('Exception when calling ApplePayApi->registerDomain: $e\n');
}
All URIs are relative to https://connect.squareup.com
Class | Method | HTTP request | Description |
---|---|---|---|
ApplePayApi | registerDomain | POST /v2/apple-pay/domains | RegisterDomain |
BankAccountsApi | getBankAccount | GET /v2/bank-accounts/{bank_account_id} | GetBankAccount |
BankAccountsApi | getBankAccountByV1Id | GET /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id |
BankAccountsApi | listBankAccounts | GET /v2/bank-accounts | ListBankAccounts |
BookingCustomAttributesApi | bulkDeleteBookingCustomAttributes | POST /v2/bookings/custom-attributes/bulk-delete | BulkDeleteBookingCustomAttributes |
BookingCustomAttributesApi | bulkUpsertBookingCustomAttributes | POST /v2/bookings/custom-attributes/bulk-upsert | BulkUpsertBookingCustomAttributes |
BookingCustomAttributesApi | createBookingCustomAttributeDefinition | POST /v2/bookings/custom-attribute-definitions | CreateBookingCustomAttributeDefinition |
BookingCustomAttributesApi | deleteBookingCustomAttribute | DELETE /v2/bookings/{booking_id}/custom-attributes/{key} | DeleteBookingCustomAttribute |
BookingCustomAttributesApi | deleteBookingCustomAttributeDefinition | DELETE /v2/bookings/custom-attribute-definitions/{key} | DeleteBookingCustomAttributeDefinition |
BookingCustomAttributesApi | listBookingCustomAttributeDefinitions | GET /v2/bookings/custom-attribute-definitions | ListBookingCustomAttributeDefinitions |
BookingCustomAttributesApi | listBookingCustomAttributes | GET /v2/bookings/{booking_id}/custom-attributes | ListBookingCustomAttributes |
BookingCustomAttributesApi | retrieveBookingCustomAttribute | GET /v2/bookings/{booking_id}/custom-attributes/{key} | RetrieveBookingCustomAttribute |
BookingCustomAttributesApi | retrieveBookingCustomAttributeDefinition | GET /v2/bookings/custom-attribute-definitions/{key} | RetrieveBookingCustomAttributeDefinition |
BookingCustomAttributesApi | updateBookingCustomAttributeDefinition | PUT /v2/bookings/custom-attribute-definitions/{key} | UpdateBookingCustomAttributeDefinition |
BookingCustomAttributesApi | upsertBookingCustomAttribute | PUT /v2/bookings/{booking_id}/custom-attributes/{key} | UpsertBookingCustomAttribute |
BookingsApi | bulkRetrieveBookings | POST /v2/bookings/bulk-retrieve | BulkRetrieveBookings |
BookingsApi | bulkRetrieveTeamMemberBookingProfiles | POST /v2/bookings/team-member-booking-profiles/bulk-retrieve | BulkRetrieveTeamMemberBookingProfiles |
BookingsApi | cancelBooking | POST /v2/bookings/{booking_id}/cancel | CancelBooking |
BookingsApi | createBooking | POST /v2/bookings | CreateBooking |
BookingsApi | listBookings | GET /v2/bookings | ListBookings |
BookingsApi | listLocationBookingProfiles | GET /v2/bookings/location-booking-profiles | ListLocationBookingProfiles |
BookingsApi | listTeamMemberBookingProfiles | GET /v2/bookings/team-member-booking-profiles | ListTeamMemberBookingProfiles |
BookingsApi | retrieveBooking | GET /v2/bookings/{booking_id} | RetrieveBooking |
BookingsApi | retrieveBusinessBookingProfile | GET /v2/bookings/business-booking-profile | RetrieveBusinessBookingProfile |
BookingsApi | retrieveLocationBookingProfile | GET /v2/bookings/location-booking-profiles/{location_id} | RetrieveLocationBookingProfile |
BookingsApi | retrieveTeamMemberBookingProfile | GET /v2/bookings/team-member-booking-profiles/{team_member_id} | RetrieveTeamMemberBookingProfile |
BookingsApi | searchAvailability | POST /v2/bookings/availability/search | SearchAvailability |
BookingsApi | updateBooking | PUT /v2/bookings/{booking_id} | UpdateBooking |
CardsApi | createCard | POST /v2/cards | CreateCard |
CardsApi | disableCard | POST /v2/cards/{card_id}/disable | DisableCard |
CardsApi | listCards | GET /v2/cards | ListCards |
CardsApi | retrieveCard | GET /v2/cards/{card_id} | RetrieveCard |
CashDrawersApi | listCashDrawerShiftEvents | GET /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents |
CashDrawersApi | listCashDrawerShifts | GET /v2/cash-drawers/shifts | ListCashDrawerShifts |
CashDrawersApi | retrieveCashDrawerShift | GET /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift |
CatalogApi | batchDeleteCatalogObjects | POST /v2/catalog/batch-delete | BatchDeleteCatalogObjects |
CatalogApi | batchRetrieveCatalogObjects | POST /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects |
CatalogApi | batchUpsertCatalogObjects | POST /v2/catalog/batch-upsert | BatchUpsertCatalogObjects |
CatalogApi | catalogInfo | GET /v2/catalog/info | CatalogInfo |
CatalogApi | deleteCatalogObject | DELETE /v2/catalog/object/{object_id} | DeleteCatalogObject |
CatalogApi | listCatalog | GET /v2/catalog/list | ListCatalog |
CatalogApi | retrieveCatalogObject | GET /v2/catalog/object/{object_id} | RetrieveCatalogObject |
CatalogApi | searchCatalogItems | POST /v2/catalog/search-catalog-items | SearchCatalogItems |
CatalogApi | searchCatalogObjects | POST /v2/catalog/search | SearchCatalogObjects |
CatalogApi | updateItemModifierLists | POST /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists |
CatalogApi | updateItemTaxes | POST /v2/catalog/update-item-taxes | UpdateItemTaxes |
CatalogApi | upsertCatalogObject | POST /v2/catalog/object | UpsertCatalogObject |
CheckoutApi | createCheckout | POST /v2/locations/{location_id}/checkouts | CreateCheckout |
CheckoutApi | createPaymentLink | POST /v2/online-checkout/payment-links | CreatePaymentLink |
CheckoutApi | deletePaymentLink | DELETE /v2/online-checkout/payment-links/{id} | DeletePaymentLink |
CheckoutApi | listPaymentLinks | GET /v2/online-checkout/payment-links | ListPaymentLinks |
CheckoutApi | retrieveLocationSettings | GET /v2/online-checkout/location-settings/{location_id} | RetrieveLocationSettings |
CheckoutApi | retrieveMerchantSettings | GET /v2/online-checkout/merchant-settings | RetrieveMerchantSettings |
CheckoutApi | retrievePaymentLink | GET /v2/online-checkout/payment-links/{id} | RetrievePaymentLink |
CheckoutApi | updateLocationSettings | PUT /v2/online-checkout/location-settings/{location_id} | UpdateLocationSettings |
CheckoutApi | updateMerchantSettings | PUT /v2/online-checkout/merchant-settings | UpdateMerchantSettings |
CheckoutApi | updatePaymentLink | PUT /v2/online-checkout/payment-links/{id} | UpdatePaymentLink |
CustomerCustomAttributesApi | bulkUpsertCustomerCustomAttributes | POST /v2/customers/custom-attributes/bulk-upsert | BulkUpsertCustomerCustomAttributes |
CustomerCustomAttributesApi | createCustomerCustomAttributeDefinition | POST /v2/customers/custom-attribute-definitions | CreateCustomerCustomAttributeDefinition |
CustomerCustomAttributesApi | deleteCustomerCustomAttribute | DELETE /v2/customers/{customer_id}/custom-attributes/{key} | DeleteCustomerCustomAttribute |
CustomerCustomAttributesApi | deleteCustomerCustomAttributeDefinition | DELETE /v2/customers/custom-attribute-definitions/{key} | DeleteCustomerCustomAttributeDefinition |
CustomerCustomAttributesApi | listCustomerCustomAttributeDefinitions | GET /v2/customers/custom-attribute-definitions | ListCustomerCustomAttributeDefinitions |
CustomerCustomAttributesApi | listCustomerCustomAttributes | GET /v2/customers/{customer_id}/custom-attributes | ListCustomerCustomAttributes |
CustomerCustomAttributesApi | retrieveCustomerCustomAttribute | GET /v2/customers/{customer_id}/custom-attributes/{key} | RetrieveCustomerCustomAttribute |
CustomerCustomAttributesApi | retrieveCustomerCustomAttributeDefinition | GET /v2/customers/custom-attribute-definitions/{key} | RetrieveCustomerCustomAttributeDefinition |
CustomerCustomAttributesApi | updateCustomerCustomAttributeDefinition | PUT /v2/customers/custom-attribute-definitions/{key} | UpdateCustomerCustomAttributeDefinition |
CustomerCustomAttributesApi | upsertCustomerCustomAttribute | POST /v2/customers/{customer_id}/custom-attributes/{key} | UpsertCustomerCustomAttribute |
CustomerGroupsApi | createCustomerGroup | POST /v2/customers/groups | CreateCustomerGroup |
CustomerGroupsApi | deleteCustomerGroup | DELETE /v2/customers/groups/{group_id} | DeleteCustomerGroup |
CustomerGroupsApi | listCustomerGroups | GET /v2/customers/groups | ListCustomerGroups |
CustomerGroupsApi | retrieveCustomerGroup | GET /v2/customers/groups/{group_id} | RetrieveCustomerGroup |
CustomerGroupsApi | updateCustomerGroup | PUT /v2/customers/groups/{group_id} | UpdateCustomerGroup |
CustomerSegmentsApi | listCustomerSegments | GET /v2/customers/segments | ListCustomerSegments |
CustomerSegmentsApi | retrieveCustomerSegment | GET /v2/customers/segments/{segment_id} | RetrieveCustomerSegment |
CustomersApi | addGroupToCustomer | PUT /v2/customers/{customer_id}/groups/{group_id} | AddGroupToCustomer |
CustomersApi | createCustomer | POST /v2/customers | CreateCustomer |
CustomersApi | createCustomerCard | POST /v2/customers/{customer_id}/cards | CreateCustomerCard |
CustomersApi | deleteCustomer | DELETE /v2/customers/{customer_id} | DeleteCustomer |
CustomersApi | deleteCustomerCard | DELETE /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard |
CustomersApi | listCustomers | GET /v2/customers | ListCustomers |
CustomersApi | removeGroupFromCustomer | DELETE /v2/customers/{customer_id}/groups/{group_id} | RemoveGroupFromCustomer |
CustomersApi | retrieveCustomer | GET /v2/customers/{customer_id} | RetrieveCustomer |
CustomersApi | searchCustomers | POST /v2/customers/search | SearchCustomers |
CustomersApi | updateCustomer | PUT /v2/customers/{customer_id} | UpdateCustomer |
DevicesApi | createDeviceCode | POST /v2/devices/codes | CreateDeviceCode |
DevicesApi | getDevice | GET /v2/devices/{device_id} | GetDevice |
DevicesApi | getDeviceCode | GET /v2/devices/codes/{id} | GetDeviceCode |
DevicesApi | listDeviceCodes | GET /v2/devices/codes | ListDeviceCodes |
DevicesApi | listDevices | GET /v2/devices | ListDevices |
DisputesApi | acceptDispute | POST /v2/disputes/{dispute_id}/accept | AcceptDispute |
DisputesApi | createDisputeEvidenceText | POST /v2/disputes/{dispute_id}/evidence-text | CreateDisputeEvidenceText |
DisputesApi | deleteDisputeEvidence | DELETE /v2/disputes/{dispute_id}/evidence/{evidence_id} | DeleteDisputeEvidence |
DisputesApi | listDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence | ListDisputeEvidence |
DisputesApi | listDisputes | GET /v2/disputes | ListDisputes |
DisputesApi | retrieveDispute | GET /v2/disputes/{dispute_id} | RetrieveDispute |
DisputesApi | retrieveDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence/{evidence_id} | RetrieveDisputeEvidence |
DisputesApi | submitEvidence | POST /v2/disputes/{dispute_id}/submit-evidence | SubmitEvidence |
EmployeesApi | listEmployees | GET /v2/employees | ListEmployees |
EmployeesApi | retrieveEmployee | GET /v2/employees/{id} | RetrieveEmployee |
GiftCardActivitiesApi | createGiftCardActivity | POST /v2/gift-cards/activities | CreateGiftCardActivity |
GiftCardActivitiesApi | listGiftCardActivities | GET /v2/gift-cards/activities | ListGiftCardActivities |
GiftCardsApi | createGiftCard | POST /v2/gift-cards | CreateGiftCard |
GiftCardsApi | linkCustomerToGiftCard | POST /v2/gift-cards/{gift_card_id}/link-customer | LinkCustomerToGiftCard |
GiftCardsApi | listGiftCards | GET /v2/gift-cards | ListGiftCards |
GiftCardsApi | retrieveGiftCard | GET /v2/gift-cards/{id} | RetrieveGiftCard |
GiftCardsApi | retrieveGiftCardFromGAN | POST /v2/gift-cards/from-gan | RetrieveGiftCardFromGAN |
GiftCardsApi | retrieveGiftCardFromNonce | POST /v2/gift-cards/from-nonce | RetrieveGiftCardFromNonce |
GiftCardsApi | unlinkCustomerFromGiftCard | POST /v2/gift-cards/{gift_card_id}/unlink-customer | UnlinkCustomerFromGiftCard |
InventoryApi | batchChangeInventory | POST /v2/inventory/changes/batch-create | BatchChangeInventory |
InventoryApi | batchRetrieveInventoryChanges | POST /v2/inventory/changes/batch-retrieve | BatchRetrieveInventoryChanges |
InventoryApi | batchRetrieveInventoryCounts | POST /v2/inventory/counts/batch-retrieve | BatchRetrieveInventoryCounts |
InventoryApi | deprecatedBatchChangeInventory | POST /v2/inventory/batch-change | DeprecatedBatchChangeInventory |
InventoryApi | deprecatedBatchRetrieveInventoryChanges | POST /v2/inventory/batch-retrieve-changes | DeprecatedBatchRetrieveInventoryChanges |
InventoryApi | deprecatedBatchRetrieveInventoryCounts | POST /v2/inventory/batch-retrieve-counts | DeprecatedBatchRetrieveInventoryCounts |
InventoryApi | deprecatedRetrieveInventoryAdjustment | GET /v2/inventory/adjustment/{adjustment_id} | DeprecatedRetrieveInventoryAdjustment |
InventoryApi | deprecatedRetrieveInventoryPhysicalCount | GET /v2/inventory/physical-count/{physical_count_id} | DeprecatedRetrieveInventoryPhysicalCount |
InventoryApi | retrieveInventoryAdjustment | GET /v2/inventory/adjustments/{adjustment_id} | RetrieveInventoryAdjustment |
InventoryApi | retrieveInventoryChanges | GET /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges |
InventoryApi | retrieveInventoryCount | GET /v2/inventory/{catalog_object_id} | RetrieveInventoryCount |
InventoryApi | retrieveInventoryPhysicalCount | GET /v2/inventory/physical-counts/{physical_count_id} | RetrieveInventoryPhysicalCount |
InventoryApi | retrieveInventoryTransfer | GET /v2/inventory/transfers/{transfer_id} | RetrieveInventoryTransfer |
InvoicesApi | cancelInvoice | POST /v2/invoices/{invoice_id}/cancel | CancelInvoice |
InvoicesApi | createInvoice | POST /v2/invoices | CreateInvoice |
InvoicesApi | deleteInvoice | DELETE /v2/invoices/{invoice_id} | DeleteInvoice |
InvoicesApi | getInvoice | GET /v2/invoices/{invoice_id} | GetInvoice |
InvoicesApi | listInvoices | GET /v2/invoices | ListInvoices |
InvoicesApi | publishInvoice | POST /v2/invoices/{invoice_id}/publish | PublishInvoice |
InvoicesApi | searchInvoices | POST /v2/invoices/search | SearchInvoices |
InvoicesApi | updateInvoice | PUT /v2/invoices/{invoice_id} | UpdateInvoice |
LaborApi | createBreakType | POST /v2/labor/break-types | CreateBreakType |
LaborApi | createShift | POST /v2/labor/shifts | CreateShift |
LaborApi | deleteBreakType | DELETE /v2/labor/break-types/{id} | DeleteBreakType |
LaborApi | deleteShift | DELETE /v2/labor/shifts/{id} | DeleteShift |
LaborApi | getBreakType | GET /v2/labor/break-types/{id} | GetBreakType |
LaborApi | getEmployeeWage | GET /v2/labor/employee-wages/{id} | GetEmployeeWage |
LaborApi | getShift | GET /v2/labor/shifts/{id} | GetShift |
LaborApi | getTeamMemberWage | GET /v2/labor/team-member-wages/{id} | GetTeamMemberWage |
LaborApi | listBreakTypes | GET /v2/labor/break-types | ListBreakTypes |
LaborApi | listEmployeeWages | GET /v2/labor/employee-wages | ListEmployeeWages |
LaborApi | listTeamMemberWages | GET /v2/labor/team-member-wages | ListTeamMemberWages |
LaborApi | listWorkweekConfigs | GET /v2/labor/workweek-configs | ListWorkweekConfigs |
LaborApi | searchShifts | POST /v2/labor/shifts/search | SearchShifts |
LaborApi | updateBreakType | PUT /v2/labor/break-types/{id} | UpdateBreakType |
LaborApi | updateShift | PUT /v2/labor/shifts/{id} | UpdateShift |
LaborApi | updateWorkweekConfig | PUT /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig |
LocationCustomAttributesApi | bulkDeleteLocationCustomAttributes | POST /v2/locations/custom-attributes/bulk-delete | BulkDeleteLocationCustomAttributes |
LocationCustomAttributesApi | bulkUpsertLocationCustomAttributes | POST /v2/locations/custom-attributes/bulk-upsert | BulkUpsertLocationCustomAttributes |
LocationCustomAttributesApi | createLocationCustomAttributeDefinition | POST /v2/locations/custom-attribute-definitions | CreateLocationCustomAttributeDefinition |
LocationCustomAttributesApi | deleteLocationCustomAttribute | DELETE /v2/locations/{location_id}/custom-attributes/{key} | DeleteLocationCustomAttribute |
LocationCustomAttributesApi | deleteLocationCustomAttributeDefinition | DELETE /v2/locations/custom-attribute-definitions/{key} | DeleteLocationCustomAttributeDefinition |
LocationCustomAttributesApi | listLocationCustomAttributeDefinitions | GET /v2/locations/custom-attribute-definitions | ListLocationCustomAttributeDefinitions |
LocationCustomAttributesApi | listLocationCustomAttributes | GET /v2/locations/{location_id}/custom-attributes | ListLocationCustomAttributes |
LocationCustomAttributesApi | retrieveLocationCustomAttribute | GET /v2/locations/{location_id}/custom-attributes/{key} | RetrieveLocationCustomAttribute |
LocationCustomAttributesApi | retrieveLocationCustomAttributeDefinition | GET /v2/locations/custom-attribute-definitions/{key} | RetrieveLocationCustomAttributeDefinition |
LocationCustomAttributesApi | updateLocationCustomAttributeDefinition | PUT /v2/locations/custom-attribute-definitions/{key} | UpdateLocationCustomAttributeDefinition |
LocationCustomAttributesApi | upsertLocationCustomAttribute | POST /v2/locations/{location_id}/custom-attributes/{key} | UpsertLocationCustomAttribute |
LocationsApi | createLocation | POST /v2/locations | CreateLocation |
LocationsApi | listLocations | GET /v2/locations | ListLocations |
LocationsApi | retrieveLocation | GET /v2/locations/{location_id} | RetrieveLocation |
LocationsApi | updateLocation | PUT /v2/locations/{location_id} | UpdateLocation |
LoyaltyApi | accumulateLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/accumulate | AccumulateLoyaltyPoints |
LoyaltyApi | adjustLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/adjust | AdjustLoyaltyPoints |
LoyaltyApi | calculateLoyaltyPoints | POST /v2/loyalty/programs/{program_id}/calculate | CalculateLoyaltyPoints |
LoyaltyApi | cancelLoyaltyPromotion | POST /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel | CancelLoyaltyPromotion |
LoyaltyApi | createLoyaltyAccount | POST /v2/loyalty/accounts | CreateLoyaltyAccount |
LoyaltyApi | createLoyaltyPromotion | POST /v2/loyalty/programs/{program_id}/promotions | CreateLoyaltyPromotion |
LoyaltyApi | createLoyaltyReward | POST /v2/loyalty/rewards | CreateLoyaltyReward |
LoyaltyApi | deleteLoyaltyReward | DELETE /v2/loyalty/rewards/{reward_id} | DeleteLoyaltyReward |
LoyaltyApi | listLoyaltyPrograms | GET /v2/loyalty/programs | ListLoyaltyPrograms |
LoyaltyApi | listLoyaltyPromotions | GET /v2/loyalty/programs/{program_id}/promotions | ListLoyaltyPromotions |
LoyaltyApi | redeemLoyaltyReward | POST /v2/loyalty/rewards/{reward_id}/redeem | RedeemLoyaltyReward |
LoyaltyApi | retrieveLoyaltyAccount | GET /v2/loyalty/accounts/{account_id} | RetrieveLoyaltyAccount |
LoyaltyApi | retrieveLoyaltyProgram | GET /v2/loyalty/programs/{program_id} | RetrieveLoyaltyProgram |
LoyaltyApi | retrieveLoyaltyPromotion | GET /v2/loyalty/programs/{program_id}/promotions/{promotion_id} | RetrieveLoyaltyPromotion |
LoyaltyApi | retrieveLoyaltyReward | GET /v2/loyalty/rewards/{reward_id} | RetrieveLoyaltyReward |
LoyaltyApi | searchLoyaltyAccounts | POST /v2/loyalty/accounts/search | SearchLoyaltyAccounts |
LoyaltyApi | searchLoyaltyEvents | POST /v2/loyalty/events/search | SearchLoyaltyEvents |
LoyaltyApi | searchLoyaltyRewards | POST /v2/loyalty/rewards/search | SearchLoyaltyRewards |
MerchantCustomAttributesApi | bulkDeleteMerchantCustomAttributes | POST /v2/merchants/custom-attributes/bulk-delete | BulkDeleteMerchantCustomAttributes |
MerchantCustomAttributesApi | bulkUpsertMerchantCustomAttributes | POST /v2/merchants/custom-attributes/bulk-upsert | BulkUpsertMerchantCustomAttributes |
MerchantCustomAttributesApi | createMerchantCustomAttributeDefinition | POST /v2/merchants/custom-attribute-definitions | CreateMerchantCustomAttributeDefinition |
MerchantCustomAttributesApi | deleteMerchantCustomAttribute | DELETE /v2/merchants/{merchant_id}/custom-attributes/{key} | DeleteMerchantCustomAttribute |
MerchantCustomAttributesApi | deleteMerchantCustomAttributeDefinition | DELETE /v2/merchants/custom-attribute-definitions/{key} | DeleteMerchantCustomAttributeDefinition |
MerchantCustomAttributesApi | listMerchantCustomAttributeDefinitions | GET /v2/merchants/custom-attribute-definitions | ListMerchantCustomAttributeDefinitions |
MerchantCustomAttributesApi | listMerchantCustomAttributes | GET /v2/merchants/{merchant_id}/custom-attributes | ListMerchantCustomAttributes |
MerchantCustomAttributesApi | retrieveMerchantCustomAttribute | GET /v2/merchants/{merchant_id}/custom-attributes/{key} | RetrieveMerchantCustomAttribute |
MerchantCustomAttributesApi | retrieveMerchantCustomAttributeDefinition | GET /v2/merchants/custom-attribute-definitions/{key} | RetrieveMerchantCustomAttributeDefinition |
MerchantCustomAttributesApi | updateMerchantCustomAttributeDefinition | PUT /v2/merchants/custom-attribute-definitions/{key} | UpdateMerchantCustomAttributeDefinition |
MerchantCustomAttributesApi | upsertMerchantCustomAttribute | POST /v2/merchants/{merchant_id}/custom-attributes/{key} | UpsertMerchantCustomAttribute |
MerchantsApi | listMerchants | GET /v2/merchants | ListMerchants |
MerchantsApi | retrieveMerchant | GET /v2/merchants/{merchant_id} | RetrieveMerchant |
MobileAuthorizationApi | createMobileAuthorizationCode | POST /mobile/authorization-code | CreateMobileAuthorizationCode |
OAuthApi | obtainToken | POST /oauth2/token | ObtainToken |
OAuthApi | renewToken | POST /oauth2/clients/{client_id}/access-token/renew | RenewToken |
OAuthApi | retrieveTokenStatus | POST /oauth2/token/status | RetrieveTokenStatus |
OAuthApi | revokeToken | POST /oauth2/revoke | RevokeToken |
OrderCustomAttributesApi | bulkDeleteOrderCustomAttributes | POST /v2/orders/custom-attributes/bulk-delete | BulkDeleteOrderCustomAttributes |
OrderCustomAttributesApi | bulkUpsertOrderCustomAttributes | POST /v2/orders/custom-attributes/bulk-upsert | BulkUpsertOrderCustomAttributes |
OrderCustomAttributesApi | createOrderCustomAttributeDefinition | POST /v2/orders/custom-attribute-definitions | CreateOrderCustomAttributeDefinition |
OrderCustomAttributesApi | deleteOrderCustomAttribute | DELETE /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} | DeleteOrderCustomAttribute |
OrderCustomAttributesApi | deleteOrderCustomAttributeDefinition | DELETE /v2/orders/custom-attribute-definitions/{key} | DeleteOrderCustomAttributeDefinition |
OrderCustomAttributesApi | listOrderCustomAttributeDefinitions | GET /v2/orders/custom-attribute-definitions | ListOrderCustomAttributeDefinitions |
OrderCustomAttributesApi | listOrderCustomAttributes | GET /v2/orders/{order_id}/custom-attributes | ListOrderCustomAttributes |
OrderCustomAttributesApi | retrieveOrderCustomAttribute | GET /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} | RetrieveOrderCustomAttribute |
OrderCustomAttributesApi | retrieveOrderCustomAttributeDefinition | GET /v2/orders/custom-attribute-definitions/{key} | RetrieveOrderCustomAttributeDefinition |
OrderCustomAttributesApi | updateOrderCustomAttributeDefinition | PUT /v2/orders/custom-attribute-definitions/{key} | UpdateOrderCustomAttributeDefinition |
OrderCustomAttributesApi | upsertOrderCustomAttribute | POST /v2/orders/{order_id}/custom-attributes/{custom_attribute_key} | UpsertOrderCustomAttribute |
OrdersApi | batchRetrieveOrders | POST /v2/orders/batch-retrieve | BatchRetrieveOrders |
OrdersApi | calculateOrder | POST /v2/orders/calculate | CalculateOrder |
OrdersApi | cloneOrder | POST /v2/orders/clone | CloneOrder |
OrdersApi | createOrder | POST /v2/orders | CreateOrder |
OrdersApi | payOrder | POST /v2/orders/{order_id}/pay | PayOrder |
OrdersApi | retrieveOrder | GET /v2/orders/{order_id} | RetrieveOrder |
OrdersApi | searchOrders | POST /v2/orders/search | SearchOrders |
OrdersApi | updateOrder | PUT /v2/orders/{order_id} | UpdateOrder |
PaymentsApi | cancelPayment | POST /v2/payments/{payment_id}/cancel | CancelPayment |
PaymentsApi | cancelPaymentByIdempotencyKey | POST /v2/payments/cancel | CancelPaymentByIdempotencyKey |
PaymentsApi | completePayment | POST /v2/payments/{payment_id}/complete | CompletePayment |
PaymentsApi | createPayment | POST /v2/payments | CreatePayment |
PaymentsApi | getPayment | GET /v2/payments/{payment_id} | GetPayment |
PaymentsApi | listPayments | GET /v2/payments | ListPayments |
PaymentsApi | updatePayment | PUT /v2/payments/{payment_id} | UpdatePayment |
PayoutsApi | getPayout | GET /v2/payouts/{payout_id} | GetPayout |
PayoutsApi | listPayoutEntries | GET /v2/payouts/{payout_id}/payout-entries | ListPayoutEntries |
PayoutsApi | listPayouts | GET /v2/payouts | ListPayouts |
RefundsApi | getPaymentRefund | GET /v2/refunds/{refund_id} | GetPaymentRefund |
RefundsApi | listPaymentRefunds | GET /v2/refunds | ListPaymentRefunds |
RefundsApi | refundPayment | POST /v2/refunds | RefundPayment |
SitesApi | listSites | GET /v2/sites | ListSites |
SnippetsApi | deleteSnippet | DELETE /v2/sites/{site_id}/snippet | DeleteSnippet |
SnippetsApi | retrieveSnippet | GET /v2/sites/{site_id}/snippet | RetrieveSnippet |
SnippetsApi | upsertSnippet | POST /v2/sites/{site_id}/snippet | UpsertSnippet |
SubscriptionsApi | bulkSwapPlan | POST /v2/subscriptions/bulk-swap-plan | BulkSwapPlan |
SubscriptionsApi | cancelSubscription | POST /v2/subscriptions/{subscription_id}/cancel | CancelSubscription |
SubscriptionsApi | changeBillingAnchorDate | POST /v2/subscriptions/{subscription_id}/billing-anchor | ChangeBillingAnchorDate |
SubscriptionsApi | createSubscription | POST /v2/subscriptions | CreateSubscription |
SubscriptionsApi | deleteSubscriptionAction | DELETE /v2/subscriptions/{subscription_id}/actions/{action_id} | DeleteSubscriptionAction |
SubscriptionsApi | listSubscriptionEvents | GET /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents |
SubscriptionsApi | pauseSubscription | POST /v2/subscriptions/{subscription_id}/pause | PauseSubscription |
SubscriptionsApi | resumeSubscription | POST /v2/subscriptions/{subscription_id}/resume | ResumeSubscription |
SubscriptionsApi | retrieveSubscription | GET /v2/subscriptions/{subscription_id} | RetrieveSubscription |
SubscriptionsApi | searchSubscriptions | POST /v2/subscriptions/search | SearchSubscriptions |
SubscriptionsApi | swapPlan | POST /v2/subscriptions/{subscription_id}/swap-plan | SwapPlan |
SubscriptionsApi | updateSubscription | PUT /v2/subscriptions/{subscription_id} | UpdateSubscription |
TeamApi | bulkCreateTeamMembers | POST /v2/team-members/bulk-create | BulkCreateTeamMembers |
TeamApi | bulkUpdateTeamMembers | POST /v2/team-members/bulk-update | BulkUpdateTeamMembers |
TeamApi | createTeamMember | POST /v2/team-members | CreateTeamMember |
TeamApi | retrieveTeamMember | GET /v2/team-members/{team_member_id} | RetrieveTeamMember |
TeamApi | retrieveWageSetting | GET /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting |
TeamApi | searchTeamMembers | POST /v2/team-members/search | SearchTeamMembers |
TeamApi | updateTeamMember | PUT /v2/team-members/{team_member_id} | UpdateTeamMember |
TeamApi | updateWageSetting | PUT /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting |
TerminalApi | cancelTerminalAction | POST /v2/terminals/actions/{action_id}/cancel | CancelTerminalAction |
TerminalApi | cancelTerminalCheckout | POST /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout |
TerminalApi | cancelTerminalRefund | POST /v2/terminals/refunds/{terminal_refund_id}/cancel | CancelTerminalRefund |
TerminalApi | createTerminalAction | POST /v2/terminals/actions | CreateTerminalAction |
TerminalApi | createTerminalCheckout | POST /v2/terminals/checkouts | CreateTerminalCheckout |
TerminalApi | createTerminalRefund | POST /v2/terminals/refunds | CreateTerminalRefund |
TerminalApi | dismissTerminalAction | POST /v2/terminals/actions/{action_id}/dismiss | DismissTerminalAction |
TerminalApi | dismissTerminalCheckout | POST /v2/terminals/checkouts/{checkout_id}/dismiss | DismissTerminalCheckout |
TerminalApi | dismissTerminalRefund | POST /v2/terminals/refunds/{terminal_refund_id}/dismiss | DismissTerminalRefund |
TerminalApi | getTerminalAction | GET /v2/terminals/actions/{action_id} | GetTerminalAction |
TerminalApi | getTerminalCheckout | GET /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout |
TerminalApi | getTerminalRefund | GET /v2/terminals/refunds/{terminal_refund_id} | GetTerminalRefund |
TerminalApi | searchTerminalActions | POST /v2/terminals/actions/search | SearchTerminalActions |
TerminalApi | searchTerminalCheckouts | POST /v2/terminals/checkouts/search | SearchTerminalCheckouts |
TerminalApi | searchTerminalRefunds | POST /v2/terminals/refunds/search | SearchTerminalRefunds |
TransactionsApi | captureTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction |
TransactionsApi | listTransactions | GET /v2/locations/{location_id}/transactions | ListTransactions |
TransactionsApi | retrieveTransaction | GET /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction |
TransactionsApi | voidTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction |
V1TransactionsApi | v1CreateRefund | POST /v1/{location_id}/refunds | V1CreateRefund |
V1TransactionsApi | v1ListOrders | GET /v1/{location_id}/orders | V1ListOrders |
V1TransactionsApi | v1ListPayments | GET /v1/{location_id}/payments | V1ListPayments |
V1TransactionsApi | v1ListRefunds | GET /v1/{location_id}/refunds | V1ListRefunds |
V1TransactionsApi | v1ListSettlements | GET /v1/{location_id}/settlements | V1ListSettlements |
V1TransactionsApi | v1RetrieveOrder | GET /v1/{location_id}/orders/{order_id} | V1RetrieveOrder |
V1TransactionsApi | v1RetrievePayment | GET /v1/{location_id}/payments/{payment_id} | V1RetrievePayment |
V1TransactionsApi | v1RetrieveSettlement | GET /v1/{location_id}/settlements/{settlement_id} | V1RetrieveSettlement |
V1TransactionsApi | v1UpdateOrder | PUT /v1/{location_id}/orders/{order_id} | V1UpdateOrder |
VendorsApi | bulkCreateVendors | POST /v2/vendors/bulk-create | BulkCreateVendors |
VendorsApi | bulkRetrieveVendors | POST /v2/vendors/bulk-retrieve | BulkRetrieveVendors |
VendorsApi | bulkUpdateVendors | PUT /v2/vendors/bulk-update | BulkUpdateVendors |
VendorsApi | createVendor | POST /v2/vendors/create | CreateVendor |
VendorsApi | retrieveVendor | GET /v2/vendors/{vendor_id} | RetrieveVendor |
VendorsApi | searchVendors | POST /v2/vendors/search | SearchVendors |
VendorsApi | updateVendor | PUT /v2/vendors/{vendor_id} | UpdateVendor |
WebhookSubscriptionsApi | createWebhookSubscription | POST /v2/webhooks/subscriptions | CreateWebhookSubscription |
WebhookSubscriptionsApi | deleteWebhookSubscription | DELETE /v2/webhooks/subscriptions/{subscription_id} | DeleteWebhookSubscription |
WebhookSubscriptionsApi | listWebhookEventTypes | GET /v2/webhooks/event-types | ListWebhookEventTypes |
WebhookSubscriptionsApi | listWebhookSubscriptions | GET /v2/webhooks/subscriptions | ListWebhookSubscriptions |
WebhookSubscriptionsApi | retrieveWebhookSubscription | GET /v2/webhooks/subscriptions/{subscription_id} | RetrieveWebhookSubscription |
WebhookSubscriptionsApi | testWebhookSubscription | POST /v2/webhooks/subscriptions/{subscription_id}/test | TestWebhookSubscription |
WebhookSubscriptionsApi | updateWebhookSubscription | PUT /v2/webhooks/subscriptions/{subscription_id} | UpdateWebhookSubscription |
WebhookSubscriptionsApi | updateWebhookSubscriptionSignatureKey | POST /v2/webhooks/subscriptions/{subscription_id}/signature-key | UpdateWebhookSubscriptionSignatureKey |
- ACHDetails
- AcceptDisputeResponse
- AcceptedPaymentMethods
- AccumulateLoyaltyPointsRequest
- AccumulateLoyaltyPointsResponse
- ActionCancelReason
- ActivityType
- AddGroupToCustomerResponse
- AdditionalRecipient
- Address
- AdjustLoyaltyPointsRequest
- AdjustLoyaltyPointsResponse
- AfterpayDetails
- ApplicationDetails
- ApplicationDetailsExternalSquareProduct
- ApplicationType
- AppointmentSegment
- ArchivedState
- Availability
- BankAccount
- BankAccountPaymentDetails
- BankAccountStatus
- BankAccountType
- BatchChangeInventoryRequest
- BatchChangeInventoryResponse
- BatchDeleteCatalogObjectsRequest
- BatchDeleteCatalogObjectsResponse
- BatchRetrieveCatalogObjectsRequest
- BatchRetrieveCatalogObjectsResponse
- BatchRetrieveInventoryChangesRequest
- BatchRetrieveInventoryChangesResponse
- BatchRetrieveInventoryCountsRequest
- BatchRetrieveInventoryCountsResponse
- BatchRetrieveOrdersRequest
- BatchRetrieveOrdersResponse
- BatchUpsertCatalogObjectsRequest
- BatchUpsertCatalogObjectsResponse
- Booking
- BookingBookingSource
- BookingCreatorDetails
- BookingCreatorDetailsCreatorType
- BookingCustomAttributeDeleteRequest
- BookingCustomAttributeDeleteResponse
- BookingCustomAttributeUpsertRequest
- BookingCustomAttributeUpsertResponse
- BookingStatus
- BreakType
- BulkCreateTeamMembersRequest
- BulkCreateTeamMembersResponse
- BulkCreateVendorsRequest
- BulkCreateVendorsResponse
- BulkDeleteBookingCustomAttributesRequest
- BulkDeleteBookingCustomAttributesResponse
- BulkDeleteLocationCustomAttributesRequest
- BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest
- BulkDeleteLocationCustomAttributesResponse
- BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse
- BulkDeleteMerchantCustomAttributesRequest
- BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest
- BulkDeleteMerchantCustomAttributesResponse
- BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse
- BulkDeleteOrderCustomAttributesRequest
- BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute
- BulkDeleteOrderCustomAttributesResponse
- BulkRetrieveBookingsRequest
- BulkRetrieveBookingsResponse
- BulkRetrieveTeamMemberBookingProfilesRequest
- BulkRetrieveTeamMemberBookingProfilesResponse
- BulkRetrieveVendorsRequest
- BulkRetrieveVendorsResponse
- BulkSwapPlanRequest
- BulkSwapPlanResponse
- BulkUpdateTeamMembersRequest
- BulkUpdateTeamMembersResponse
- BulkUpdateVendorsRequest
- BulkUpdateVendorsResponse
- BulkUpsertBookingCustomAttributesRequest
- BulkUpsertBookingCustomAttributesResponse
- BulkUpsertCustomerCustomAttributesRequest
- BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest
- BulkUpsertCustomerCustomAttributesResponse
- BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse
- BulkUpsertLocationCustomAttributesRequest
- BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest
- BulkUpsertLocationCustomAttributesResponse
- BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse
- BulkUpsertMerchantCustomAttributesRequest
- BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest
- BulkUpsertMerchantCustomAttributesResponse
- BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse
- BulkUpsertOrderCustomAttributesRequest
- BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute
- BulkUpsertOrderCustomAttributesResponse
- BusinessAppointmentSettings
- BusinessAppointmentSettingsAlignmentTime
- BusinessAppointmentSettingsBookingLocationType
- BusinessAppointmentSettingsCancellationPolicy
- BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
- BusinessBookingProfile
- BusinessBookingProfileBookingPolicy
- BusinessBookingProfileCustomerTimezoneChoice
- BusinessHours
- BusinessHoursPeriod
- BuyNowPayLaterDetails
- CalculateLoyaltyPointsRequest
- CalculateLoyaltyPointsResponse
- CalculateOrderRequest
- CalculateOrderResponse
- CancelBookingRequest
- CancelBookingResponse
- CancelInvoiceRequest
- CancelInvoiceResponse
- CancelLoyaltyPromotionResponse
- CancelPaymentByIdempotencyKeyRequest
- CancelPaymentByIdempotencyKeyResponse
- CancelPaymentResponse
- CancelSubscriptionResponse
- CancelTerminalActionResponse
- CancelTerminalCheckoutResponse
- CancelTerminalRefundResponse
- CaptureTransactionResponse
- Card
- CardBrand
- CardCoBrand
- CardPaymentDetails
- CardPaymentTimeline
- CardPrepaidType
- CardType
- CashAppDetails
- CashDrawerDevice
- CashDrawerEventType
- CashDrawerShift
- CashDrawerShiftEvent
- CashDrawerShiftState
- CashDrawerShiftSummary
- CashPaymentDetails
- CatalogAvailabilityPeriod
- CatalogCategory
- CatalogCategoryType
- CatalogCustomAttributeDefinition
- CatalogCustomAttributeDefinitionAppVisibility
- CatalogCustomAttributeDefinitionNumberConfig
- CatalogCustomAttributeDefinitionSelectionConfig
- CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
- CatalogCustomAttributeDefinitionSellerVisibility
- CatalogCustomAttributeDefinitionStringConfig
- CatalogCustomAttributeDefinitionType
- CatalogCustomAttributeValue
- CatalogDiscount
- CatalogDiscountModifyTaxBasis
- CatalogDiscountType
- CatalogEcomSeoData
- CatalogIdMapping
- CatalogImage
- CatalogInfoResponse
- CatalogInfoResponseLimits
- CatalogItem
- CatalogItemModifierListInfo
- CatalogItemOption
- CatalogItemOptionForItem
- CatalogItemOptionValue
- CatalogItemOptionValueForItemVariation
- CatalogItemProductType
- CatalogItemVariation
- CatalogMeasurementUnit
- CatalogModifier
- CatalogModifierList
- CatalogModifierListSelectionType
- CatalogModifierOverride
- CatalogObject
- CatalogObjectBatch
- CatalogObjectCategory
- CatalogObjectReference
- CatalogObjectType
- CatalogPricingRule
- CatalogPricingType
- CatalogProductSet
- CatalogQuery
- CatalogQueryExact
- CatalogQueryItemVariationsForItemOptionValues
- CatalogQueryItemsForItemOptions
- CatalogQueryItemsForModifierList
- CatalogQueryItemsForTax
- CatalogQueryPrefix
- CatalogQueryRange
- CatalogQuerySet
- CatalogQuerySortedAttribute
- CatalogQueryText
- CatalogQuickAmount
- CatalogQuickAmountType
- CatalogQuickAmountsSettings
- CatalogQuickAmountsSettingsOption
- CatalogStockConversion
- CatalogSubscriptionPlan
- CatalogSubscriptionPlanVariation
- CatalogTax
- CatalogTimePeriod
- CatalogV1Id
- CategoryPathToRootNode
- ChangeBillingAnchorDateRequest
- ChangeBillingAnchorDateResponse
- ChangeTiming
- ChargeRequest
- ChargeRequestAdditionalRecipient
- ChargeResponse
- Checkout
- CheckoutLocationSettings
- CheckoutLocationSettingsBranding
- CheckoutLocationSettingsBrandingButtonShape
- CheckoutLocationSettingsBrandingHeaderType
- CheckoutLocationSettingsCoupons
- CheckoutLocationSettingsPolicy
- CheckoutLocationSettingsTipping
- CheckoutMerchantSettings
- CheckoutMerchantSettingsPaymentMethods
- CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay
- CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange
- CheckoutMerchantSettingsPaymentMethodsPaymentMethod
- CheckoutOptions
- CheckoutOptionsPaymentType
- ClearpayDetails
- CloneOrderRequest
- CloneOrderResponse
- CollectedData
- CompletePaymentRequest
- CompletePaymentResponse
- Component
- ComponentComponentType
- ConfirmationDecision
- ConfirmationOptions
- Coordinates
- Country
- CreateBookingCustomAttributeDefinitionRequest
- CreateBookingCustomAttributeDefinitionResponse
- CreateBookingRequest
- CreateBookingResponse
- CreateBreakTypeRequest
- CreateBreakTypeResponse
- CreateCardRequest
- CreateCardResponse
- CreateCheckoutRequest
- CreateCheckoutResponse
- CreateCustomerCardRequest
- CreateCustomerCardResponse
- CreateCustomerCustomAttributeDefinitionRequest
- CreateCustomerCustomAttributeDefinitionResponse
- CreateCustomerGroupRequest
- CreateCustomerGroupResponse
- CreateCustomerRequest
- CreateCustomerResponse
- CreateDeviceCodeRequest
- CreateDeviceCodeResponse
- CreateDisputeEvidenceTextRequest
- CreateDisputeEvidenceTextResponse
- CreateGiftCardActivityRequest
- CreateGiftCardActivityResponse
- CreateGiftCardRequest
- CreateGiftCardResponse
- CreateInvoiceRequest
- CreateInvoiceResponse
- CreateLocationCustomAttributeDefinitionRequest
- CreateLocationCustomAttributeDefinitionResponse
- CreateLocationRequest
- CreateLocationResponse
- CreateLoyaltyAccountRequest
- CreateLoyaltyAccountResponse
- CreateLoyaltyPromotionRequest
- CreateLoyaltyPromotionResponse
- CreateLoyaltyRewardRequest
- CreateLoyaltyRewardResponse
- CreateMerchantCustomAttributeDefinitionRequest
- CreateMerchantCustomAttributeDefinitionResponse
- CreateMobileAuthorizationCodeRequest
- CreateMobileAuthorizationCodeResponse
- CreateOrderCustomAttributeDefinitionRequest
- CreateOrderCustomAttributeDefinitionResponse
- CreateOrderRequest
- CreateOrderResponse
- CreatePaymentLinkRequest
- CreatePaymentLinkResponse
- CreatePaymentRequest
- CreatePaymentResponse
- CreateRefundRequest
- CreateRefundResponse
- CreateShiftRequest
- CreateShiftResponse
- CreateSubscriptionRequest
- CreateSubscriptionResponse
- CreateTeamMemberRequest
- CreateTeamMemberResponse
- CreateTerminalActionRequest
- CreateTerminalActionResponse
- CreateTerminalCheckoutRequest
- CreateTerminalCheckoutResponse
- CreateTerminalRefundRequest
- CreateTerminalRefundResponse
- CreateVendorRequest
- CreateVendorResponse
- CreateWebhookSubscriptionRequest
- CreateWebhookSubscriptionResponse
- Currency
- CustomAttribute
- CustomAttributeDefinition
- CustomAttributeDefinitionVisibility
- CustomAttributeFilter
- CustomField
- Customer
- CustomerAddressFilter
- CustomerCreationSource
- CustomerCreationSourceFilter
- CustomerCustomAttributeFilter
- CustomerCustomAttributeFilterValue
- CustomerCustomAttributeFilters
- CustomerDetails
- CustomerFilter
- CustomerGroup
- CustomerInclusionExclusion
- CustomerPreferences
- CustomerQuery
- CustomerSegment
- CustomerSort
- CustomerSortField
- CustomerTaxIds
- CustomerTextFilter
- DataCollectionOptions
- DataCollectionOptionsInputType
- DateRange
- DayOfWeek
- DeleteBookingCustomAttributeDefinitionResponse
- DeleteBookingCustomAttributeResponse
- DeleteBreakTypeResponse
- DeleteCatalogObjectResponse
- DeleteCustomerCardResponse
- DeleteCustomerCustomAttributeDefinitionResponse
- DeleteCustomerCustomAttributeResponse
- DeleteCustomerGroupResponse
- DeleteCustomerRequest
- DeleteCustomerResponse
- DeleteDisputeEvidenceResponse
- DeleteInvoiceRequest
- DeleteInvoiceResponse
- DeleteLocationCustomAttributeDefinitionResponse
- DeleteLocationCustomAttributeResponse
- DeleteLoyaltyRewardResponse
- DeleteMerchantCustomAttributeDefinitionResponse
- DeleteMerchantCustomAttributeResponse
- DeleteOrderCustomAttributeDefinitionResponse
- DeleteOrderCustomAttributeResponse
- DeletePaymentLinkResponse
- DeleteShiftResponse
- DeleteSnippetResponse
- DeleteSubscriptionActionResponse
- DeleteWebhookSubscriptionResponse
- DeprecatedCreateDisputeEvidenceFileRequest
- DeprecatedCreateDisputeEvidenceFileResponse
- DeprecatedCreateDisputeEvidenceTextRequest
- DeprecatedCreateDisputeEvidenceTextResponse
- Destination
- DestinationDetails
- DestinationDetailsCardRefundDetails
- DestinationType
- Device
- DeviceAttributes
- DeviceAttributesDeviceType
- DeviceCheckoutOptions
- DeviceCode
- DeviceCodeStatus
- DeviceComponentDetailsApplicationDetails
- DeviceComponentDetailsBatteryDetails
- DeviceComponentDetailsCardReaderDetails
- DeviceComponentDetailsEthernetDetails
- DeviceComponentDetailsExternalPower
- DeviceComponentDetailsMeasurement
- DeviceComponentDetailsNetworkInterfaceDetails
- DeviceComponentDetailsWiFiDetails
- DeviceDetails
- DeviceMetadata
- DeviceStatus
- DeviceStatusCategory
- DigitalWalletDetails
- DisableCardResponse
- DismissTerminalActionResponse
- DismissTerminalCheckoutResponse
- DismissTerminalRefundResponse
- Dispute
- DisputeEvidence
- DisputeEvidenceFile
- DisputeEvidenceType
- DisputeReason
- DisputeState
- DisputedPayment
- EcomVisibility
- Employee
- EmployeeStatus
- EmployeeWage
- Error
- ErrorCategory
- ErrorCode
- Event
- EventData
- EventTypeMetadata
- ExcludeStrategy
- ExternalPaymentDetails
- FilterValue
- FloatNumberRange
- Fulfillment
- FulfillmentDeliveryDetails
- FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType
- FulfillmentFulfillmentEntry
- FulfillmentFulfillmentLineItemApplication
- FulfillmentPickupDetails
- FulfillmentPickupDetailsCurbsidePickupDetails
- FulfillmentPickupDetailsScheduleType
- FulfillmentRecipient
- FulfillmentShipmentDetails
- FulfillmentState
- FulfillmentType
- GetBankAccountByV1IdResponse
- GetBankAccountResponse
- GetBreakTypeResponse
- GetDeviceCodeResponse
- GetDeviceResponse
- GetEmployeeWageResponse
- GetInvoiceResponse
- GetPaymentRefundResponse
- GetPaymentResponse
- GetPayoutResponse
- GetShiftResponse
- GetTeamMemberWageResponse
- GetTerminalActionResponse
- GetTerminalCheckoutResponse
- GetTerminalRefundResponse
- GiftCard
- GiftCardActivity
- GiftCardActivityActivate
- GiftCardActivityAdjustDecrement
- GiftCardActivityAdjustDecrementReason
- GiftCardActivityAdjustIncrement
- GiftCardActivityAdjustIncrementReason
- GiftCardActivityBlock
- GiftCardActivityBlockReason
- GiftCardActivityClearBalance
- GiftCardActivityClearBalanceReason
- GiftCardActivityDeactivate
- GiftCardActivityDeactivateReason
- GiftCardActivityImport
- GiftCardActivityImportReversal
- GiftCardActivityLoad
- GiftCardActivityRedeem
- GiftCardActivityRedeemStatus
- GiftCardActivityRefund
- GiftCardActivityTransferBalanceFrom
- GiftCardActivityTransferBalanceTo
- GiftCardActivityType
- GiftCardActivityUnblock
- GiftCardActivityUnblockReason
- GiftCardActivityUnlinkedActivityRefund
- GiftCardGANSource
- GiftCardStatus
- GiftCardType
- InventoryAdjustment
- InventoryAdjustmentGroup
- InventoryAlertType
- InventoryChange
- InventoryChangeType
- InventoryCount
- InventoryPhysicalCount
- InventoryState
- InventoryTransfer
- Invoice
- InvoiceAcceptedPaymentMethods
- InvoiceAutomaticPaymentSource
- InvoiceCustomField
- InvoiceCustomFieldPlacement
- InvoiceDeliveryMethod
- InvoiceFilter
- InvoicePaymentReminder
- InvoicePaymentReminderStatus
- InvoicePaymentRequest
- InvoiceQuery
- InvoiceRecipient
- InvoiceRecipientTaxIds
- InvoiceRequestMethod
- InvoiceRequestType
- InvoiceSort
- InvoiceSortField
- InvoiceStatus
- ItemVariationLocationOverrides
- JobAssignment
- JobAssignmentPayType
- LinkCustomerToGiftCardRequest
- LinkCustomerToGiftCardResponse
- ListBankAccountsRequest
- ListBankAccountsResponse
- ListBookingCustomAttributeDefinitionsRequest
- ListBookingCustomAttributeDefinitionsResponse
- ListBookingCustomAttributesRequest
- ListBookingCustomAttributesResponse
- ListBookingsRequest
- ListBookingsResponse
- ListBreakTypesRequest
- ListBreakTypesResponse
- ListCardsRequest
- ListCardsResponse
- ListCashDrawerShiftEventsRequest
- ListCashDrawerShiftEventsResponse
- ListCashDrawerShiftsRequest
- ListCashDrawerShiftsResponse
- ListCatalogRequest
- ListCatalogResponse
- ListCustomerCustomAttributeDefinitionsRequest
- ListCustomerCustomAttributeDefinitionsResponse
- ListCustomerCustomAttributesRequest
- ListCustomerCustomAttributesResponse
- ListCustomerGroupsRequest
- ListCustomerGroupsResponse
- ListCustomerSegmentsRequest
- ListCustomerSegmentsResponse
- ListCustomersRequest
- ListCustomersResponse
- ListDeviceCodesRequest
- ListDeviceCodesResponse
- ListDevicesRequest
- ListDevicesResponse
- ListDisputeEvidenceRequest
- ListDisputeEvidenceResponse
- ListDisputesRequest
- ListDisputesResponse
- ListEmployeeWagesRequest
- ListEmployeeWagesResponse
- ListEmployeesRequest
- ListEmployeesResponse
- ListGiftCardActivitiesRequest
- ListGiftCardActivitiesResponse
- ListGiftCardsRequest
- ListGiftCardsResponse
- ListInvoicesRequest
- ListInvoicesResponse
- ListLocationBookingProfilesRequest
- ListLocationBookingProfilesResponse
- ListLocationCustomAttributeDefinitionsRequest
- ListLocationCustomAttributeDefinitionsResponse
- ListLocationCustomAttributesRequest
- ListLocationCustomAttributesResponse
- ListLocationsResponse
- ListLoyaltyProgramsResponse
- ListLoyaltyPromotionsRequest
- ListLoyaltyPromotionsResponse
- ListMerchantCustomAttributeDefinitionsRequest
- ListMerchantCustomAttributeDefinitionsResponse
- ListMerchantCustomAttributesRequest
- ListMerchantCustomAttributesResponse
- ListMerchantsRequest
- ListMerchantsResponse
- ListOrderCustomAttributeDefinitionsRequest
- ListOrderCustomAttributeDefinitionsResponse
- ListOrderCustomAttributesRequest
- ListOrderCustomAttributesResponse
- ListPaymentLinksRequest
- ListPaymentLinksResponse
- ListPaymentRefundsRequest
- ListPaymentRefundsResponse
- ListPaymentsRequest
- ListPaymentsResponse
- ListPayoutEntriesRequest
- ListPayoutEntriesResponse
- ListPayoutsRequest
- ListPayoutsResponse
- ListRefundsRequest
- ListRefundsResponse
- ListSitesResponse
- ListSubscriptionEventsRequest
- ListSubscriptionEventsResponse
- ListTeamMemberBookingProfilesRequest
- ListTeamMemberBookingProfilesResponse
- ListTeamMemberWagesRequest
- ListTeamMemberWagesResponse
- ListTransactionsRequest
- ListTransactionsResponse
- ListWebhookEventTypesRequest
- ListWebhookEventTypesResponse
- ListWebhookSubscriptionsRequest
- ListWebhookSubscriptionsResponse
- ListWorkweekConfigsRequest
- ListWorkweekConfigsResponse
- Location
- LocationBookingProfile
- LocationCapability
- LocationStatus
- LocationType
- LoyaltyAccount
- LoyaltyAccountExpiringPointDeadline
- LoyaltyAccountMapping
- LoyaltyAccountMappingType
- LoyaltyEvent
- LoyaltyEventAccumulatePoints
- LoyaltyEventAccumulatePromotionPoints
- LoyaltyEventAdjustPoints
- LoyaltyEventCreateReward
- LoyaltyEventDateTimeFilter
- LoyaltyEventDeleteReward
- LoyaltyEventExpirePoints
- LoyaltyEventFilter
- LoyaltyEventLocationFilter
- LoyaltyEventLoyaltyAccountFilter
- LoyaltyEventOrderFilter
- LoyaltyEventOther
- LoyaltyEventQuery
- LoyaltyEventRedeemReward
- LoyaltyEventSource
- LoyaltyEventType
- LoyaltyEventTypeFilter
- LoyaltyProgram
- LoyaltyProgramAccrualRule
- LoyaltyProgramAccrualRuleCategoryData
- LoyaltyProgramAccrualRuleItemVariationData
- LoyaltyProgramAccrualRuleSpendData
- LoyaltyProgramAccrualRuleTaxMode
- LoyaltyProgramAccrualRuleType
- LoyaltyProgramAccrualRuleVisitData
- LoyaltyProgramExpirationPolicy
- LoyaltyProgramRewardDefinition
- LoyaltyProgramRewardDefinitionScope
- LoyaltyProgramRewardDefinitionType
- LoyaltyProgramRewardTier
- LoyaltyProgramStatus
- LoyaltyProgramTerminology
- LoyaltyPromotion
- LoyaltyPromotionAvailableTimeData
- LoyaltyPromotionIncentive
- LoyaltyPromotionIncentivePointsAdditionData
- LoyaltyPromotionIncentivePointsMultiplierData
- LoyaltyPromotionIncentiveType
- LoyaltyPromotionStatus
- LoyaltyPromotionTriggerLimit
- LoyaltyPromotionTriggerLimitInterval
- LoyaltyReward
- LoyaltyRewardStatus
- MeasurementUnit
- MeasurementUnitArea
- MeasurementUnitCustom
- MeasurementUnitGeneric
- MeasurementUnitLength
- MeasurementUnitTime
- MeasurementUnitUnitType
- MeasurementUnitVolume
- MeasurementUnitWeight
- Merchant
- MerchantStatus
- ModelBreak
- ModifierLocationOverrides
- Money
- ObtainTokenRequest
- ObtainTokenResponse
- Order
- OrderCreated
- OrderCreatedObject
- OrderEntry
- OrderFulfillment
- OrderFulfillmentDeliveryDetails
- OrderFulfillmentDeliveryDetailsScheduleType
- OrderFulfillmentFulfillmentEntry
- OrderFulfillmentFulfillmentLineItemApplication
- OrderFulfillmentPickupDetails
- OrderFulfillmentPickupDetailsCurbsidePickupDetails
- OrderFulfillmentPickupDetailsScheduleType
- OrderFulfillmentRecipient
- OrderFulfillmentShipmentDetails
- OrderFulfillmentState
- OrderFulfillmentType
- OrderFulfillmentUpdated
- OrderFulfillmentUpdatedObject
- OrderFulfillmentUpdatedUpdate
- OrderLineItem
- OrderLineItemAppliedDiscount
- OrderLineItemAppliedServiceCharge
- OrderLineItemAppliedTax
- OrderLineItemDiscount
- OrderLineItemDiscountScope
- OrderLineItemDiscountType
- OrderLineItemItemType
- OrderLineItemModifier
- OrderLineItemPricingBlocklists
- OrderLineItemPricingBlocklistsBlockedDiscount
- OrderLineItemPricingBlocklistsBlockedTax
- OrderLineItemTax
- OrderLineItemTaxScope
- OrderLineItemTaxType
- OrderMoneyAmounts
- OrderPricingOptions
- OrderQuantityUnit
- OrderReturn
- OrderReturnDiscount
- OrderReturnLineItem
- OrderReturnLineItemModifier
- OrderReturnServiceCharge
- OrderReturnTax
- OrderReward
- OrderRoundingAdjustment
- OrderServiceCharge
- OrderServiceChargeCalculationPhase
- OrderServiceChargeScope
- OrderServiceChargeTreatmentType
- OrderServiceChargeType
- OrderSource
- OrderState
- OrderUpdated
- OrderUpdatedObject
- PaginationCursor
- PauseSubscriptionRequest
- PauseSubscriptionResponse
- PayOrderRequest
- PayOrderResponse
- Payment
- PaymentBalanceActivityAppFeeRefundDetail
- PaymentBalanceActivityAppFeeRevenueDetail
- PaymentBalanceActivityAutomaticSavingsDetail
- PaymentBalanceActivityAutomaticSavingsReversedDetail
- PaymentBalanceActivityChargeDetail
- PaymentBalanceActivityDepositFeeDetail
- PaymentBalanceActivityDisputeDetail
- PaymentBalanceActivityFeeDetail
- PaymentBalanceActivityFreeProcessingDetail
- PaymentBalanceActivityHoldAdjustmentDetail
- PaymentBalanceActivityOpenDisputeDetail
- PaymentBalanceActivityOtherAdjustmentDetail
- PaymentBalanceActivityOtherDetail
- PaymentBalanceActivityRefundDetail
- PaymentBalanceActivityReleaseAdjustmentDetail
- PaymentBalanceActivityReserveHoldDetail
- PaymentBalanceActivityReserveReleaseDetail
- PaymentBalanceActivitySquareCapitalPaymentDetail
- PaymentBalanceActivitySquareCapitalReversedPaymentDetail
- PaymentBalanceActivityTaxOnFeeDetail
- PaymentBalanceActivityThirdPartyFeeDetail
- PaymentBalanceActivityThirdPartyFeeRefundDetail
- PaymentLink
- PaymentLinkRelatedResources
- PaymentOptions
- PaymentOptionsDelayAction
- PaymentRefund
- Payout
- PayoutEntry
- PayoutFee
- PayoutFeeType
- PayoutStatus
- PayoutType
- Phase
- PhaseInput
- PrePopulatedData
- ProcessingFee
- Product
- ProductType
- PublishInvoiceRequest
- PublishInvoiceResponse
- QrCodeOptions
- QuantityRatio
- QuickPay
- Range
- ReceiptOptions
- RedeemLoyaltyRewardRequest
- RedeemLoyaltyRewardResponse
- Refund
- RefundPaymentRequest
- RefundPaymentResponse
- RefundStatus
- RegisterDomainRequest
- RegisterDomainResponse
- RegisterDomainResponseStatus
- RemoveGroupFromCustomerResponse
- RenewTokenRequest
- RenewTokenResponse
- ResumeSubscriptionRequest
- ResumeSubscriptionResponse
- RetrieveBookingCustomAttributeDefinitionRequest
- RetrieveBookingCustomAttributeDefinitionResponse
- RetrieveBookingCustomAttributeRequest
- RetrieveBookingCustomAttributeResponse
- RetrieveBookingResponse
- RetrieveBusinessBookingProfileResponse
- RetrieveCardResponse
- RetrieveCashDrawerShiftRequest
- RetrieveCashDrawerShiftResponse
- RetrieveCatalogObjectRequest
- RetrieveCatalogObjectResponse
- RetrieveCustomerCustomAttributeDefinitionRequest
- RetrieveCustomerCustomAttributeDefinitionResponse
- RetrieveCustomerCustomAttributeRequest
- RetrieveCustomerCustomAttributeResponse
- RetrieveCustomerGroupResponse
- RetrieveCustomerResponse
- RetrieveCustomerSegmentResponse
- RetrieveDisputeEvidenceResponse
- RetrieveDisputeResponse
- RetrieveEmployeeResponse
- RetrieveGiftCardFromGANRequest
- RetrieveGiftCardFromGANResponse
- RetrieveGiftCardFromNonceRequest
- RetrieveGiftCardFromNonceResponse
- RetrieveGiftCardResponse
- RetrieveInventoryAdjustmentResponse
- RetrieveInventoryChangesRequest
- RetrieveInventoryChangesResponse
- RetrieveInventoryCountRequest
- RetrieveInventoryCountResponse
- RetrieveInventoryPhysicalCountResponse
- RetrieveInventoryTransferResponse
- RetrieveLocationBookingProfileResponse
- RetrieveLocationCustomAttributeDefinitionRequest
- RetrieveLocationCustomAttributeDefinitionResponse
- RetrieveLocationCustomAttributeRequest
- RetrieveLocationCustomAttributeResponse
- RetrieveLocationResponse
- RetrieveLocationSettingsResponse
- RetrieveLoyaltyAccountResponse
- RetrieveLoyaltyProgramResponse
- RetrieveLoyaltyPromotionResponse
- RetrieveLoyaltyRewardResponse
- RetrieveMerchantCustomAttributeDefinitionRequest
- RetrieveMerchantCustomAttributeDefinitionResponse
- RetrieveMerchantCustomAttributeRequest
- RetrieveMerchantCustomAttributeResponse
- RetrieveMerchantResponse
- RetrieveMerchantSettingsResponse
- RetrieveOrderCustomAttributeDefinitionRequest
- RetrieveOrderCustomAttributeDefinitionResponse
- RetrieveOrderCustomAttributeRequest
- RetrieveOrderCustomAttributeResponse
- RetrieveOrderResponse
- RetrievePaymentLinkResponse
- RetrieveSnippetResponse
- RetrieveSubscriptionRequest
- RetrieveSubscriptionResponse
- RetrieveTeamMemberBookingProfileResponse
- RetrieveTeamMemberResponse
- RetrieveTokenStatusResponse
- RetrieveTransactionResponse
- RetrieveVendorResponse
- RetrieveWageSettingResponse
- RetrieveWebhookSubscriptionResponse
- RevokeTokenRequest
- RevokeTokenResponse
- RiskEvaluation
- RiskEvaluationRiskLevel
- SaveCardOptions
- SearchAvailabilityFilter
- SearchAvailabilityQuery
- SearchAvailabilityRequest
- SearchAvailabilityResponse
- SearchCatalogItemsRequest
- SearchCatalogItemsRequestStockLevel
- SearchCatalogItemsResponse
- SearchCatalogObjectsRequest
- SearchCatalogObjectsResponse
- SearchCustomersRequest
- SearchCustomersResponse
- SearchInvoicesRequest
- SearchInvoicesResponse
- SearchLoyaltyAccountsRequest
- SearchLoyaltyAccountsRequestLoyaltyAccountQuery
- SearchLoyaltyAccountsResponse
- SearchLoyaltyEventsRequest
- SearchLoyaltyEventsResponse
- SearchLoyaltyRewardsRequest
- SearchLoyaltyRewardsRequestLoyaltyRewardQuery
- SearchLoyaltyRewardsResponse
- SearchOrdersCustomerFilter
- SearchOrdersDateTimeFilter
- SearchOrdersFilter
- SearchOrdersFulfillmentFilter
- SearchOrdersQuery
- SearchOrdersRequest
- SearchOrdersResponse
- SearchOrdersSort
- SearchOrdersSortField
- SearchOrdersSourceFilter
- SearchOrdersStateFilter
- SearchShiftsRequest
- SearchShiftsResponse
- SearchSubscriptionsFilter
- SearchSubscriptionsQuery
- SearchSubscriptionsRequest
- SearchSubscriptionsResponse
- SearchTeamMembersFilter
- SearchTeamMembersQuery
- SearchTeamMembersRequest
- SearchTeamMembersResponse
- SearchTerminalActionsRequest
- SearchTerminalActionsResponse
- SearchTerminalCheckoutsRequest
- SearchTerminalCheckoutsResponse
- SearchTerminalRefundsRequest
- SearchTerminalRefundsResponse
- SearchVendorsRequest
- SearchVendorsRequestFilter
- SearchVendorsRequestSort
- SearchVendorsRequestSortField
- SearchVendorsResponse
- SegmentFilter
- SelectOption
- SelectOptions
- Shift
- ShiftFilter
- ShiftFilterStatus
- ShiftQuery
- ShiftSort
- ShiftSortField
- ShiftStatus
- ShiftWage
- ShiftWorkday
- ShiftWorkdayMatcher
- ShippingFee
- SignatureImage
- SignatureOptions
- Site
- Snippet
- SnippetResponse
- SortOrder
- SourceApplication
- SquareAccountDetails
- StandardUnitDescription
- StandardUnitDescriptionGroup
- SubmitEvidenceResponse
- Subscription
- SubscriptionAction
- SubscriptionActionType
- SubscriptionCadence
- SubscriptionEvent
- SubscriptionEventInfo
- SubscriptionEventInfoCode
- SubscriptionEventSubscriptionEventType
- SubscriptionPhase
- SubscriptionPricing
- SubscriptionPricingType
- SubscriptionSource
- SubscriptionStatus
- SubscriptionTestResult
- SwapPlanRequest
- SwapPlanResponse
- TaxCalculationPhase
- TaxIds
- TaxInclusionType
- TeamMember
- TeamMemberAssignedLocations
- TeamMemberAssignedLocationsAssignmentType
- TeamMemberBookingProfile
- TeamMemberInvitationStatus
- TeamMemberStatus
- TeamMemberWage
- Tender
- TenderBankAccountDetails
- TenderBankAccountDetailsStatus
- TenderBuyNowPayLaterDetails
- TenderBuyNowPayLaterDetailsBrand
- TenderBuyNowPayLaterDetailsStatus
- TenderCardDetails
- TenderCardDetailsEntryMethod
- TenderCardDetailsStatus
- TenderCashDetails
- TenderSquareAccountDetails
- TenderSquareAccountDetailsStatus
- TenderType
- TerminalAction
- TerminalActionActionType
- TerminalActionQuery
- TerminalActionQueryFilter
- TerminalActionQuerySort
- TerminalCheckout
- TerminalCheckoutQuery
- TerminalCheckoutQueryFilter
- TerminalCheckoutQuerySort
- TerminalRefund
- TerminalRefundQuery
- TerminalRefundQueryFilter
- TerminalRefundQuerySort
- TestWebhookSubscriptionRequest
- TestWebhookSubscriptionResponse
- TimeRange
- TipSettings
- Transaction
- TransactionProduct
- TransactionType
- UnlinkCustomerFromGiftCardRequest
- UnlinkCustomerFromGiftCardResponse
- UpdateBookingCustomAttributeDefinitionRequest
- UpdateBookingCustomAttributeDefinitionResponse
- UpdateBookingRequest
- UpdateBookingResponse
- UpdateBreakTypeRequest
- UpdateBreakTypeResponse
- UpdateCustomerCustomAttributeDefinitionRequest
- UpdateCustomerCustomAttributeDefinitionResponse
- UpdateCustomerGroupRequest
- UpdateCustomerGroupResponse
- UpdateCustomerRequest
- UpdateCustomerResponse
- UpdateInvoiceRequest
- UpdateInvoiceResponse
- UpdateItemModifierListsRequest
- UpdateItemModifierListsResponse
- UpdateItemTaxesRequest
- UpdateItemTaxesResponse
- UpdateLocationCustomAttributeDefinitionRequest
- UpdateLocationCustomAttributeDefinitionResponse
- UpdateLocationRequest
- UpdateLocationResponse
- UpdateLocationSettingsRequest
- UpdateLocationSettingsResponse
- UpdateMerchantCustomAttributeDefinitionRequest
- UpdateMerchantCustomAttributeDefinitionResponse
- UpdateMerchantSettingsRequest
- UpdateMerchantSettingsResponse
- UpdateOrderCustomAttributeDefinitionRequest
- UpdateOrderCustomAttributeDefinitionResponse
- UpdateOrderRequest
- UpdateOrderResponse
- UpdatePaymentLinkRequest
- UpdatePaymentLinkResponse
- UpdatePaymentRequest
- UpdatePaymentResponse
- UpdateShiftRequest
- UpdateShiftResponse
- UpdateSubscriptionRequest
- UpdateSubscriptionResponse
- UpdateTeamMemberRequest
- UpdateTeamMemberResponse
- UpdateVendorRequest
- UpdateVendorResponse
- UpdateWageSettingRequest
- UpdateWageSettingResponse
- UpdateWebhookSubscriptionRequest
- UpdateWebhookSubscriptionResponse
- UpdateWebhookSubscriptionSignatureKeyRequest
- UpdateWebhookSubscriptionSignatureKeyResponse
- UpdateWorkweekConfigRequest
- UpdateWorkweekConfigResponse
- UpsertBookingCustomAttributeRequest
- UpsertBookingCustomAttributeResponse
- UpsertCatalogObjectRequest
- UpsertCatalogObjectResponse
- UpsertCustomerCustomAttributeRequest
- UpsertCustomerCustomAttributeResponse
- UpsertLocationCustomAttributeRequest
- UpsertLocationCustomAttributeResponse
- UpsertMerchantCustomAttributeRequest
- UpsertMerchantCustomAttributeResponse
- UpsertOrderCustomAttributeRequest
- UpsertOrderCustomAttributeResponse
- UpsertSnippetRequest
- UpsertSnippetResponse
- V1CreateRefundRequest
- V1CreateRefundRequestType
- V1Device
- V1ListOrdersRequest
- V1ListOrdersResponse
- V1ListPaymentsRequest
- V1ListPaymentsResponse
- V1ListRefundsRequest
- V1ListRefundsResponse
- V1ListSettlementsRequest
- V1ListSettlementsRequestStatus
- V1ListSettlementsResponse
- V1Money
- V1Order
- V1OrderHistoryEntry
- V1OrderHistoryEntryAction
- V1OrderState
- V1Payment
- V1PaymentDiscount
- V1PaymentItemDetail
- V1PaymentItemization
- V1PaymentItemizationItemizationType
- V1PaymentModifier
- V1PaymentSurcharge
- V1PaymentSurchargeType
- V1PaymentTax
- V1PaymentTaxInclusionType
- V1PhoneNumber
- V1Refund
- V1RefundType
- V1Settlement
- V1SettlementEntry
- V1SettlementEntryType
- V1SettlementStatus
- V1Tender
- V1TenderCardBrand
- V1TenderEntryMethod
- V1TenderType
- V1UpdateOrderRequest
- V1UpdateOrderRequestAction
- Vendor
- VendorContact
- VendorStatus
- VisibilityFilter
- VoidTransactionResponse
- WageSetting
- WebhookSubscription
- Weekday
- WorkweekConfig
Authentication schemes defined for the API:
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://connect.squareup.com/oauth2/authorize
- Scopes:
- BANK_ACCOUNTS_READ: HTTP Method:
GET
Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint. - CASH_DRAWER_READ: HTTP Method:
GET
Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint. - CUSTOMERS_READ: HTTP Method:
GET
Grants read access to customer information. For example, to call the ListCustomers endpoint. - CUSTOMERS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to customer information. For example, to create and update customer profiles. - DEVICE_CREDENTIAL_MANAGEMENT: HTTP Method:
POST
,GET
Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint. - EMPLOYEES_READ: HTTP Method:
GET
Grants read access to employee profile information. For example, to call the Connect v1 Employees API. - EMPLOYEES_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to employee profile information. For example, to create and modify employee profiles. - INVENTORY_READ: HTTP Method:
GET
Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. - INVENTORY_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. - ITEMS_READ: HTTP Method:
GET
Grants read access to product catalog information. For example, to obtain objects in a product catalog. - ITEMS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to product catalog information. For example, to modify or add to a product catalog. - LOYALTY_READ: HTTP Method:
GET
Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint. - LOYALTY_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint. - MERCHANT_PROFILE_READ: HTTP Method:
GET
Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - ORDERS_READ: HTTP Method:
GET
Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. - ORDERS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to order information. For example, to call the CreateCheckout endpoint. - PAYMENTS_READ: HTTP Method:
GET
Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. - PAYMENTS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: HTTP Method:
POST
,PUT
,DELETE
Allow third party applications to deduct a portion of each transaction amount. Required to use multiparty transaction functionality with the Payments API. - PAYMENTS_WRITE_IN_PERSON: HTTP Method:
POST
,PUT
,DELETE
Grants write access to payments and refunds information. For example, to process in-person payments. - SETTLEMENTS_READ: HTTP Method:
GET
Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. - TIMECARDS_READ: HTTP Method:
GET
Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. - TIMECARDS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to employee shift information. For example, to create and modify employee shifts. - TIMECARDS_SETTINGS_READ: HTTP Method:
GET
Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. - TIMECARDS_SETTINGS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. - APPOINTMENTS_READ: HTTP Method:
GET
,POST
Grants read access to booking information. For example, to call the RetrieveBooking endpoint. - APPOINTMENTS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to booking information. For example, to call the CreateBooking endpoint. - APPOINTMENTS_BUSINESS_SETTINGS_READ: HTTP Method:
GET
Grants read access to booking business settings. For example, to call the ListTeamMemberBookingProfiles endpoint. - INVOICES_READ: HTTP Method:
GET
,POST
Grants read access to invoice information. For example, to call the ListInvoices endpoint. - INVOICES_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to invoice information. For example, to call the CreateInvoice endpoint. - SUBSCRIPTIONS_READ: HTTP Method:
GET
,POST
Grants read access to subscription information. For example, to call the RetrieveSubscription endpoint. - SUBSCRIPTIONS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to subscription information. For example, to call the CreateSubscription endpoint. - DISPUTES_READ: HTTP Method:
GET
Grants read access to dispute information. For example, to call the RetrieveDispute endpoint. - DISPUTES_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to dispute information. For example, to call the SubmitEvidence endpoint. - GIFTCARDS_READ: HTTP Method:
GET
,POST
Grants read access to gift card information. For example, to call the RetrieveGiftCard endpoint. - GIFTCARDS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to gift card information. For example, to call the CreateGiftCard endpoint. - ONLINE_STORE_SNIPPETS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Write access to ECOM online store snippets on published websites. - ONLINE_STORE_SNIPPETS_READ: HTTP Method:
GET
,POST
Read access to ECOM online store snippets on published websites. - ONLINE_STORE_SITE_READ: HTTP Method:
GET
,POST
Read access to ECOM online store site details. - PAYMENTS_WRITE_SHARED_ONFILE: HTTP Method:
POST
,PUT
,DELETE
Allows the developer to process payments on behalf of a seller using a shared on file payment method. - APPOINTMENTS_ALL_READ: HTTP Method:
GET
,POST
Grants read access to all of a seller's booking information, calendar, and business details. This permission must be accompanied by theAPPOINTMENTS_READ
permission. - APPOINTMENTS_ALL_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to all booking details, including double-booking a seller. This permission must be accompanied by theAPPOINTMENTS_WRITE
permission. - MERCHANT_PROFILE_WRITE: HTTP Method:
POST
,PUT
Grants write access to business and location information. For example, to create a new location or update the business hours at an existing location. - VENDOR_READ: HTTP Method:
GET
,POST
Grants read access to vendor information, for example, when calling theRetrieveVendor
endpoint. - VENDOR_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to vendor information, for example, when calling theBulkUpdateVendors
endpoint. - PAYOUTS_READ: HTTP Method:
GET
Grants read access to payouts and payout entries information. For example, to call the Connect v2ListPayouts
endpoint. - RESERVATIONS_READ: HTTP Method:
GET
Grants read access to reservation information, for example, when calling theRetrieveReservation
endpoint. - RESERVATIONS_WRITE: HTTP Method:
POST
,PUT
,DELETE
Grants write access to reservation information, for example, when calling theCreateReservation
endpoint. - RESTAURANT_CHECKS_READ: HTTP Method:
GET
Grants read access to check information, for example, when calling theRetrieveCheck
endpoint. - DEVICES_READ: HTTP Method:
GET
Grants read access to device information. For example, to call theGetDevice
andListDevices
endpoints. - CHANNELS_READ: HTTP Method:
GET
Grants read access to view channels, for example, when calling theRetrieveChannel
endpoint. - CHANNELS_CREATE: HTTP Method:
POST
Grants write access to create channels, for example, when calling theCreateChannel
endpoint. - CHANNELS_UPDATE: HTTP Method:
PUT
Grants write access to update channels, for example, when calling theUpdateChannel
endpoint.
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header