Make api request
The Make API Request tool by Square provides a unified interface to access a wide range of Square's API services efficiently. Designed for developers, it streamlines API interactions by supporting multiple service categories like payments, orders, customers, and more in a single platform.
Features
- Supports comprehensive Square API services including payments, orders, customers, inventory, and more.
- Enables precise API method calls such as list, create, update, and delete within each service category.
- Flexible request object input allows custom parameters tailored to specific API calls.
- Integrated type checking ensures accurate and error-free API requests before execution.
- Simplifies complex API management by consolidating multiple endpoints into one intuitive tool.
Benefits
- Accelerates development by providing a centralized tool for all Square API operations.
- Reduces errors with built-in type validations before making API calls.
- Enhances productivity by enabling quick access to diverse Square services without switching tools.
- Facilitates customization and scalability in managing business operations through flexible request configurations.
- Supports seamless integration of payments, orders, customers, and more into your applications or systems.
Description
Unified tool for all Square API operations. Be sure to get types before calling. Available services: applepay, bankaccounts, bookingcustomattributes, bookings, cards, cashdrawers, catalog, checkout, customercustomattributes, customergroups, customersegments, customers, devices, disputes, events, giftcardactivities, giftcards, inventory, invoices, labor, locationcustomattributes, locations, loyalty, merchantcustomattributes, merchants, ordercustomattributes, orders, payments, payouts, refunds, sites, snippets, subscriptions, team, terminal, vendors, webhooksubscriptions.
Parameters
3 parameters
| Name | Type | Description |
|---|---|---|
| servicerequired | string | The Square API service category (e.g., 'catalog', 'payments') |
| methodrequired | string | The API method to call (e.g., 'list', 'create') |
| request | object | The request object for the API call. This should be a JSON object with the required parameters for the method. DO NOT enclose in quotes. |