openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 1.11 MB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://connect.squareup.com"}],"info":{"contact":{"email":"developers@squareup.com","name":"Square Developer Platform","url":"https://squareup.com/developers"},"description":"Client library for accessing the Square Connect APIs","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://connect.squareup.com/tos","title":"Square Connect API","version":"2.0","x-apisguru-categories":["payment"],"x-logo":{"url":"http://square.github.io/images/logo.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/square/connect-api-specification/master/api.json","version":"3.0"}],"x-providerName":"squareup.com"},"externalDocs":{"description":"Read the official documentation here:","url":"https://docs.connect.squareup.com/"},"paths":{"/mobile/authorization-code":{"post":{"description":"Generates code to authorize a mobile application to connect to a Square card reader\n\nAuthorization codes are one-time-use and expire __60 minutes__ after being issued.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nReplace `ACCESS_TOKEN` with a\n[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).","operationId":"CreateMobileAuthorizationCode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMobileAuthorizationCodeRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMobileAuthorizationCodeResponse"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_WRITE_IN_PERSON"]}],"summary":"CreateMobileAuthorizationCode","tags":["MobileAuthorization"],"x-oauthpermissions":["PAYMENTS_WRITE_IN_PERSON"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/oauth2/clients/{client_id}/access-token/renew":{"post":{"description":"`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see\n[Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).\n\n\nRenews an OAuth access token before it expires.\n\nOAuth access tokens besides your application's personal access token expire after __30 days__.\nYou can also renew expired tokens within __15 days__ of their expiration.\nYou cannot renew an access token that has been expired for more than 15 days.\nInstead, the associated user must re-complete the OAuth flow from the beginning.\n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the Credentials\npage in the [developer dashboard](https://developer.squareup.com/apps).","operationId":"RenewToken","parameters":[{"description":"Your application ID, available from the [developer dashboard](https://developer.squareup.com/apps).","in":"path","name":"client_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenewTokenRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenewTokenResponse"}}},"description":"Success"}},"security":[{"oauth2ClientSecret":[]}],"summary":"RenewToken","tags":["OAuth"],"x-is-deprecated":true,"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/oauth2/revoke":{"post":{"description":"Revokes an access token generated with the OAuth flow.\n\nIf an account has more than one OAuth access token for your application, this\nendpoint revokes all of them, regardless of which token you specify. When an\nOAuth access token is revoked, all of the active subscriptions associated\nwith that OAuth token are canceled immediately.\n\n__Important:__ The `Authorization` header for this endpoint must have the\nfollowing format:\n\n```\nAuthorization: Client APPLICATION_SECRET\n```\n\nReplace `APPLICATION_SECRET` with the application secret on the OAuth\npage in the [developer dashboard](https://developer.squareup.com/apps).","operationId":"RevokeToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeTokenRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeTokenResponse"}}},"description":"Success"}},"security":[{"oauth2ClientSecret":[]}],"summary":"RevokeToken","tags":["OAuth"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/oauth2/token":{"post":{"description":"Returns an OAuth access token.\n\nThe endpoint supports distinct methods of obtaining OAuth access tokens.\nApplications specify a method by adding the `grant_type` parameter\nin the request and also provide relevant information.\n\n__Note:__ Regardless of the method application specified,\nthe endpoint always returns two items; an OAuth access token and\na refresh token in the response.\n\n__OAuth tokens should only live on secure servers. Application clients\nshould never interact directly with OAuth tokens__.","operationId":"ObtainToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObtainTokenRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObtainTokenResponse"}}},"description":"Success"}},"security":[],"summary":"ObtainToken","tags":["OAuth"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/me/employees":{"get":{"description":"Provides summary information for all of a business's employees.","operationId":"ListEmployees","parameters":[{"description":"The order in which employees are listed in the response, based on their created_at field. Default value: ASC","in":"query","name":"order","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format","in":"query","name":"begin_updated_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_updated_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.","in":"query","name":"begin_created_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_created_at","required":false,"schema":{"type":"string"}},{"description":"If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"If provided, the endpoint returns only employee entities with the specified external_id.","in":"query","name":"external_id","required":false,"schema":{"type":"string"}},{"description":"The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1Employee"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"ListEmployees","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"},"post":{"description":" Use the CreateEmployee endpoint to add an employee to a Square\naccount. Employees created with the Connect API have an initial status\nof `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale\nuntil they are activated from the Square Dashboard. Employee status\ncannot be changed with the Connect API.\n\nEmployee entities cannot be deleted. To disable employee profiles,\nset the employee's status to <code>INACTIVE</code>","operationId":"CreateEmployee","requestBody":{"$ref":"#/components/requestBodies/V1Employee"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Employee"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"CreateEmployee","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/me/employees/{employee_id}":{"get":{"description":"Provides the details for a single employee.","operationId":"RetrieveEmployee","parameters":[{"description":"The employee's ID.","in":"path","name":"employee_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Employee"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"RetrieveEmployee","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"},"put":{"description":"","operationId":"UpdateEmployee","parameters":[{"description":"The ID of the role to modify.","in":"path","name":"employee_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/V1Employee"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Employee"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"UpdateEmployee","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/me/roles":{"get":{"description":"Provides summary information for all of a business's employee roles.","operationId":"ListEmployeeRoles","parameters":[{"description":"The order in which employees are listed in the response, based on their created_at field.Default value: ASC","in":"query","name":"order","required":false,"schema":{"type":"string"}},{"description":"The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1EmployeeRole"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"ListEmployeeRoles","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"},"post":{"description":"Creates an employee role you can then assign to employees.\n\nSquare accounts can include any number of roles that can be assigned to\nemployees. These roles define the actions and permissions granted to an\nemployee with that role. For example, an employee with a \"Shift Manager\"\nrole might be able to issue refunds in Square Point of Sale, whereas an\nemployee with a \"Clerk\" role might not.\n\nRoles are assigned with the [V1UpdateEmployee](https://developer.squareup.com/reference/square_2021-08-18/v1-employees-api/update-employee-role)\nendpoint. An employee can have only one role at a time.\n\nIf an employee has no role, they have none of the permissions associated\nwith roles. All employees can accept payments with Square Point of Sale.","operationId":"CreateEmployeeRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeeRole"}}},"description":"An EmployeeRole object with a name and permissions, and an optional owner flag.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeeRole"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"CreateEmployeeRole","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/me/roles/{role_id}":{"get":{"description":"Provides the details for a single employee role.","operationId":"RetrieveEmployeeRole","parameters":[{"description":"The role's ID.","in":"path","name":"role_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeeRole"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"RetrieveEmployeeRole","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"},"put":{"description":"Modifies the details of an employee role.","operationId":"UpdateEmployeeRole","parameters":[{"description":"The ID of the role to modify.","in":"path","name":"role_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeeRole"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeeRole"}}},"description":"Success"}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"UpdateEmployeeRole","tags":["V1Employees"],"x-oauthpermissions":["EMPLOYEES_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/{location_id}/orders":{"get":{"description":"Provides summary information for a merchant's online store orders.","operationId":"ListOrders","parameters":[{"description":"The ID of the location to list online store orders for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order in which payments are listed in the response.","in":"query","name":"order","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The maximum number of payments to return in a single response. This value cannot exceed 200.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"x-is-deprecated":true},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1Order"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["ORDERS_READ"]}],"summary":"ListOrders","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["ORDERS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z","x-visibility":"SDK_ONLY"}},"/v1/{location_id}/orders/{order_id}":{"get":{"description":"Provides comprehensive information for a single online store order, including the order's history.","operationId":"RetrieveOrder","parameters":[{"description":"The ID of the order's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint","in":"path","name":"order_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Order"}}},"description":"Success"}},"security":[{"oauth2":["ORDERS_READ"]}],"summary":"RetrieveOrder","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["ORDERS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z","x-visibility":"SDK_ONLY"},"put":{"description":"Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:","operationId":"UpdateOrder","parameters":[{"description":"The ID of the order's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint","in":"path","name":"order_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1UpdateOrderRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Order"}}},"description":"Success"}},"security":[{"oauth2":["ORDERS_WRITE"]}],"summary":"UpdateOrder","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["ORDERS_WRITE"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z","x-visibility":"SDK_ONLY"}},"/v1/{location_id}/payments":{"get":{"description":"Provides summary information for all payments taken for a given\nSquare account during a date range. Date ranges cannot exceed 1 year in\nlength. See Date ranges for details of inclusive and exclusive dates.\n\n*Note**: Details for payments processed with Square Point of Sale while\nin offline mode may not be transmitted to Square for up to 72 hours.\nOffline payments have a `created_at` value that reflects the time the\npayment was originally processed, not the time it was subsequently\ntransmitted to Square. Consequently, the ListPayments endpoint might\nlist an offline payment chronologically between online payments that\nwere seen in a previous request.","operationId":"ListPayments","parameters":[{"description":"The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order in which payments are listed in the response.","in":"query","name":"order","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.","in":"query","name":"begin_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.","in":"query","name":"end_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The maximum number of payments to return in a single response. This value cannot exceed 200.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"x-is-deprecated":true},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.","in":"query","name":"include_partial","required":false,"schema":{"type":"boolean"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1Payment"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"ListPayments","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["PAYMENTS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/{location_id}/payments/{payment_id}":{"get":{"description":"Provides comprehensive information for a single payment.","operationId":"RetrievePayment","parameters":[{"description":"The ID of the payment's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.","in":"path","name":"payment_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Payment"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"RetrievePayment","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["PAYMENTS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/{location_id}/refunds":{"get":{"description":"Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.","operationId":"ListRefunds","parameters":[{"description":"The ID of the location to list refunds for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order in which payments are listed in the response.","in":"query","name":"order","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.","in":"query","name":"begin_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.","in":"query","name":"end_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"x-is-deprecated":true},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1Refund"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"ListRefunds","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["PAYMENTS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"},"post":{"description":"Issues a refund for a previously processed payment. You must issue\na refund within 60 days of the associated payment.\n\nYou cannot issue a partial refund for a split tender payment. You must\ninstead issue a full or partial refund for a particular tender, by\nproviding the applicable tender id to the V1CreateRefund endpoint.\nIssuing a full refund for a split tender payment refunds all tenders\nassociated with the payment.\n\nIssuing a refund for a card payment is not reversible. For development\npurposes, you can create fake cash payments in Square Point of Sale and\nrefund them.","operationId":"CreateRefund","parameters":[{"description":"The ID of the original payment's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateRefundRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Refund"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_WRITE"]}],"summary":"CreateRefund","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["PAYMENTS_WRITE"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/{location_id}/settlements":{"get":{"description":"Provides summary information for all deposits and withdrawals\ninitiated by Square to a linked bank account during a date range. Date\nranges cannot exceed one year in length.\n\n*Note**: the ListSettlements endpoint does not provide entry\ninformation.","operationId":"ListSettlements","parameters":[{"description":"The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The order in which settlements are listed in the response.","in":"query","name":"order","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.","in":"query","name":"begin_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.","in":"query","name":"end_time","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The maximum number of settlements to return in a single response. This value cannot exceed 200.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"x-is-deprecated":true},{"description":"Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).","in":"query","name":"status","required":false,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/V1Settlement"},"type":"array"}}},"description":"Success"}},"security":[{"oauth2":["SETTLEMENTS_READ"]}],"summary":"ListSettlements","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["SETTLEMENTS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v1/{location_id}/settlements/{settlement_id}":{"get":{"description":"Provides comprehensive information for a single settlement.\n\nThe returned `Settlement` objects include an `entries` field that lists\nthe transactions that contribute to the settlement total. Most\nsettlement entries correspond to a payment payout, but settlement\nentries are also generated for less common events, like refunds, manual\nadjustments, or chargeback holds.\n\nSquare initiates its regular deposits as indicated in the\n[Deposit Options with Square](https://squareup.com/help/us/en/article/3807)\nhelp article. Details for a regular deposit are usually not available\nfrom Connect API endpoints before 10 p.m. PST the same day.\n\nSquare does not know when an initiated settlement **completes**, only\nwhether it has failed. A completed settlement is typically reflected in\na bank account within 3 business days, but in exceptional cases it may\ntake longer.","operationId":"RetrieveSettlement","parameters":[{"description":"The ID of the settlements's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true},{"description":"The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.","in":"path","name":"settlement_id","required":true,"schema":{"type":"string"},"x-is-deprecated":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1Settlement"}}},"description":"Success"}},"security":[{"oauth2":["SETTLEMENTS_READ"]}],"summary":"RetrieveSettlement","tags":["V1Transactions"],"x-is-deprecated":true,"x-oauthpermissions":["SETTLEMENTS_READ"],"x-release-status":"DEPRECATED","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/apple-pay/domains":{"post":{"description":"Activates a domain for use with Apple Pay on the Web and Square. A validation\nis performed on this domain by Apple to ensure that it is properly set up as\nan Apple Pay enabled domain.\n\nThis endpoint provides an easy way for platform developers to bulk activate\nApple Pay on the Web with Square for merchants using their platform.\n\nTo learn more about Web Apple Pay, see\n[Add the Apple Pay on the Web Button](https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).","operationId":"RegisterDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDomainRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDomainResponse"}}},"description":"Success"}},"security":[{"oauth2":[]}],"summary":"RegisterDomain","tags":["ApplePay"],"x-oauthpermissions":[],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bank-accounts":{"get":{"description":"Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount) objects linked to a Square account.","operationId":"ListBankAccounts","parameters":[{"description":"The pagination cursor returned by a previous call to this endpoint.\nUse it in the next `ListBankAccounts` request to retrieve the next set \nof results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Upper limit on the number of bank accounts to return in the response. \nCurrently, 1000 is the largest supported limit. You can specify a limit \nof up to 1000 bank accounts. This is also the default limit.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankAccountsResponse"}}},"description":"Success"}},"security":[{"oauth2":["BANK_ACCOUNTS_READ"]}],"summary":"ListBankAccounts","tags":["BankAccounts"],"x-oauthpermissions":["BANK_ACCOUNTS_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bank-accounts/by-v1-id/{v1_bank_account_id}":{"get":{"description":"Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount) identified by V1 bank account ID.","operationId":"GetBankAccountByV1Id","parameters":[{"description":"Connect V1 ID of the desired `BankAccount`. For more information, see \n[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).","in":"path","name":"v1_bank_account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankAccountByV1IdResponse"}}},"description":"Success"}},"security":[{"oauth2":["BANK_ACCOUNTS_READ"]}],"summary":"GetBankAccountByV1Id","tags":["BankAccounts"],"x-oauthpermissions":["BANK_ACCOUNTS_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bank-accounts/{bank_account_id}":{"get":{"description":"Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount)\nlinked to a Square account.","operationId":"GetBankAccount","parameters":[{"description":"Square-issued ID of the desired `BankAccount`.","in":"path","name":"bank_account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankAccountResponse"}}},"description":"Success"}},"security":[{"oauth2":["BANK_ACCOUNTS_READ"]}],"summary":"GetBankAccount","tags":["BankAccounts"],"x-oauthpermissions":["BANK_ACCOUNTS_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings":{"post":{"description":"Creates a booking.","operationId":"CreateBooking","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBookingRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBookingResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_WRITE"]}],"summary":"CreateBooking","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_WRITE"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/availability/search":{"post":{"description":"Searches for availabilities for booking.","operationId":"SearchAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAvailabilityRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAvailabilityResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_READ"]}],"summary":"SearchAvailability","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_READ"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/business-booking-profile":{"get":{"description":"Retrieves a seller's booking profile.","operationId":"RetrieveBusinessBookingProfile","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBusinessBookingProfileResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_BUSINESS_SETTINGS_READ"]}],"summary":"RetrieveBusinessBookingProfile","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_BUSINESS_SETTINGS_READ"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/team-member-booking-profiles":{"get":{"description":"Lists booking profiles for team members.","operationId":"ListTeamMemberBookingProfiles","parameters":[{"description":"Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).","in":"query","name":"bookable_only","required":false,"schema":{"type":"boolean"},"x-is-beta":true},{"description":"The maximum number of results to return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"x-is-beta":true},{"description":"The cursor for paginating through the results.","in":"query","name":"cursor","required":false,"schema":{"type":"string"},"x-is-beta":true},{"description":"Indicates whether to include only team members enabled at the given location in the returned result.","in":"query","name":"location_id","required":false,"schema":{"type":"string"},"x-is-beta":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTeamMemberBookingProfilesResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_BUSINESS_SETTINGS_READ"]}],"summary":"ListTeamMemberBookingProfiles","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_BUSINESS_SETTINGS_READ"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/team-member-booking-profiles/{team_member_id}":{"get":{"description":"Retrieves a team member's booking profile.","operationId":"RetrieveTeamMemberBookingProfile","parameters":[{"description":"The ID of the team member to retrieve.","in":"path","name":"team_member_id","required":true,"schema":{"type":"string"},"x-is-beta":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveTeamMemberBookingProfileResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_BUSINESS_SETTINGS_READ"]}],"summary":"RetrieveTeamMemberBookingProfile","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_BUSINESS_SETTINGS_READ"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/{booking_id}":{"get":{"description":"Retrieves a booking.","operationId":"RetrieveBooking","parameters":[{"description":"The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-retrieved booking.","in":"path","name":"booking_id","required":true,"schema":{"type":"string"},"x-is-beta":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBookingResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_READ"]}],"summary":"RetrieveBooking","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_READ"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"},"put":{"description":"Updates a booking.","operationId":"UpdateBooking","parameters":[{"description":"The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-updated booking.","in":"path","name":"booking_id","required":true,"schema":{"type":"string"},"x-is-beta":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookingRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookingResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_WRITE"]}],"summary":"UpdateBooking","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_WRITE"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/bookings/{booking_id}/cancel":{"post":{"description":"Cancels an existing booking.","operationId":"CancelBooking","parameters":[{"description":"The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-cancelled booking.","in":"path","name":"booking_id","required":true,"schema":{"type":"string"},"x-is-beta":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelBookingRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelBookingResponse"}}},"description":"Success"}},"security":[{"oauth2":["APPOINTMENTS_WRITE"]}],"summary":"CancelBooking","tags":["Bookings"],"x-is-beta":true,"x-oauthpermissions":["APPOINTMENTS_WRITE"],"x-release-status":"BETA","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/cards":{"get":{"description":"Retrieves a list of cards owned by the account making the request.\nA max of 25 cards will be returned.","operationId":"ListCards","parameters":[{"description":"A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Limit results to cards associated with the customer supplied.\nBy default, all cards owned by the merchant are returned.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Includes disabled cards.\nBy default, all enabled cards owned by the merchant are returned.","in":"query","name":"include_disabled","required":false,"schema":{"type":"boolean"}},{"description":"Limit results to cards associated with the reference_id supplied.","in":"query","name":"reference_id","required":false,"schema":{"type":"string"}},{"description":"Sorts the returned list by when the card was created with the specified order.\nThis field defaults to ASC.","in":"query","name":"sort_order","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsResponse"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"ListCards","tags":["Cards"],"x-oauthpermissions":["PAYMENTS_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"},"post":{"description":"Adds a card on file to an existing merchant.","operationId":"CreateCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCardRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCardResponse"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_WRITE"]}],"summary":"CreateCard","tags":["Cards"],"x-oauthpermissions":["PAYMENTS_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/cards/{card_id}":{"get":{"description":"Retrieves details for a specific Card.","operationId":"RetrieveCard","parameters":[{"description":"Unique ID for the desired Card.","in":"path","name":"card_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveCardResponse"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"RetrieveCard","tags":["Cards"],"x-oauthpermissions":["PAYMENTS_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/cards/{card_id}/disable":{"post":{"description":"Disables the card, preventing any further updates or charges.\nDisabling an already disabled card is allowed but has no effect.","operationId":"DisableCard","parameters":[{"description":"Unique ID for the desired Card.","in":"path","name":"card_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisableCardResponse"}}},"description":"Success"}},"security":[{"oauth2":["PAYMENTS_WRITE"]}],"summary":"DisableCard","tags":["Cards"],"x-oauthpermissions":["PAYMENTS_WRITE"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.288Z"}},"/v2/cash-drawers/shifts":{"get":{"description":"Provides the details for all of the cash drawer shifts for a location\nin a date range.","operationId":"ListCashDrawerShifts","parameters":[{"description":"The ID of the location to query for a list of cash drawer shifts.","in":"query","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC","in":"query","name":"sort_order","required":false,"schema":{"type":"string"}},{"description":"The inclusive start time of the query on opened_at, in ISO 8601 format.","in":"query","name":"begin_time","required":false,"schema":{"type":"string"}},{"description":"The exclusive end date of the query on opened_at, in ISO 8601 format.","in":"query","name":"end_time","required":false,"schema":{"type":"string"}},{"description":"Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Opaque cursor for fetching the next page of results.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCashDrawerShiftsResponse"}}},"description":"Success"}},"security":[{"oauth2":["CASH_DRAWER_READ"]}],"summary":"ListCashDrawerShifts","tags":["CashDrawers"],"x-oauthpermissions":["CASH_DRAWER_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.289Z"}},"/v2/cash-drawers/shifts/{shift_id}":{"get":{"description":"Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2021-08-18/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.","operationId":"RetrieveCashDrawerShift","parameters":[{"description":"The ID of the location to retrieve cash drawer shifts from.","in":"query","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The shift ID.","in":"path","name":"shift_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveCashDrawerShiftResponse"}}},"description":"Success"}},"security":[{"oauth2":["CASH_DRAWER_READ"]}],"summary":"RetrieveCashDrawerShift","tags":["CashDrawers"],"x-oauthpermissions":["CASH_DRAWER_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.289Z"}},"/v2/cash-drawers/shifts/{shift_id}/events":{"get":{"description":"Provides a paginated list of events for a single cash drawer shift.","operationId":"ListCashDrawerShiftEvents","parameters":[{"description":"The ID of the location to list cash drawer shifts for.","in":"query","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The shift ID.","in":"path","name":"shift_id","required":true,"schema":{"type":"string"}},{"description":"Number of resources to be returned in a page of results (200 by\ndefault, 1000 max).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Opaque cursor for fetching the next page of results.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCashDrawerShiftEventsResponse"}}},"description":"Success"}},"security":[{"oauth2":["CASH_DRAWER_READ"]}],"summary":"ListCashDrawerShiftEvents","tags":["CashDrawers"],"x-oauthpermissions":["CASH_DRAWER_READ"],"x-release-status":"PUBLIC","x-sq-version":"2025-04-15T13:52:38.289Z"}},"/v2/catalog/batch-delete":{"post":{"description":"Deletes a set of [CatalogItem](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItem)s based on the\nprovided list of target IDs and returns a set of successfully deleted IDs in\nthe response. Deletion is a cascading event such that all children of the\ntargeted object are also deleted. For example, deleting a CatalogItem will\nalso delete all of its [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only include IDs that were\nactually deleted.","operationId":"BatchDeleteCatalogObjects","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCatalogObjectsRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCatalogObjectsResponse"}}},"description":"Success"}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"BatchDeleteCatalogObjects","tags":[