{ "opencollection": "1.0.0", "info": { "name": "Square", "version": "2.0" }, "items": [ { "info": { "name": "MobileAuthorization", "type": "folder" }, "items": [ { "info": { "name": "Square Create Mobile Authorization Code", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/mobile/authorization-code", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Generates code to authorize a mobile application to connect to a Square card reader.\n\nAuthorization codes are one-time-use codes 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)." } ] }, { "info": { "name": "OAuth", "type": "folder" }, "items": [ { "info": { "name": "Square Revoke Token", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/oauth2/revoke", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. \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 for your application in the Developer Dashboard." }, { "info": { "name": "Square Obtain Token", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/oauth2/token", "body": { "type": "json", "data": "{}" } }, "docs": "Returns an OAuth access token and a refresh token unless the \n`short_lived` parameter is set to `true`, in which case the endpoint \nreturns only an access token.\n\nThe `grant_type` parameter specifies the type of OAuth request. If \n`grant_type` is `authorization_code`, you must include the authorization \ncode you received when a seller granted you authorization. If `grant_type` \nis `refresh_token`, you must provide a valid refresh token. If you're using \nan old version of the Square APIs (prior t" }, { "info": { "name": "Square Retrieve Token Status", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/oauth2/token/status", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).\n\nAdd the access token to the Authorization header of the request.\n\n__Important:__ The `Authorization` header you provide to this endpoint must have the following format:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nwhere `A" } ] }, { "info": { "name": "V1Transactions", "type": "folder" }, "items": [ { "info": { "name": "Square V1 List Orders", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v1/:location_id/orders", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to list online store orders for." }, { "name": "order", "value": "", "type": "query", "description": "The order in which payments are listed in the response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of payments to return in a single response. This value cannot exceed 200." }, { "name": "batch_token", "value": "", "type": "query", "description": "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides summary information for a merchant's online store orders." }, { "info": { "name": "Square V1 Retrieve Order", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v1/:location_id/orders/:order_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the order's associated location." }, { "name": "order_id", "value": "", "type": "path", "description": "The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides comprehensive information for a single online store order, including the order's history." }, { "info": { "name": "Square V1 Update Order", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v1/:location_id/orders/:order_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the order's associated location." }, { "name": "order_id", "value": "", "type": "path", "description": "The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:" } ] }, { "info": { "name": "ApplePay", "type": "folder" }, "items": [ { "info": { "name": "Square Register Domain", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/apple-pay/domains", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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\nNote: You will need to host a valid domain verification file on your domain to support Apple Pay. The\ncurrent version of this file is always available at https://app.sq" } ] }, { "info": { "name": "BankAccounts", "type": "folder" }, "items": [ { "info": { "name": "Square List Bank Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bank-accounts", "params": [ { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "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." }, { "name": "location_id", "value": "", "type": "query", "description": "Location ID. You can specify this optional filter \nto retrieve only the linked bank accounts belonging to a specific location." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account." }, { "info": { "name": "Square Get Bank Account by V1 ID", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bank-accounts/by-v1-id/:v1_bank_account_id", "params": [ { "name": "v1_bank_account_id", "value": "", "type": "path", "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)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID." }, { "info": { "name": "Square Get Bank Account", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bank-accounts/:bank_account_id", "params": [ { "name": "bank_account_id", "value": "", "type": "path", "description": "Square-issued ID of the desired `BankAccount`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns details of a [BankAccount](entity:BankAccount)\nlinked to a Square account." } ] }, { "info": { "name": "Bookings", "type": "folder" }, "items": [ { "info": { "name": "Square List Bookings", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results per page to return in a paged response." }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results." }, { "name": "customer_id", "value": "", "type": "query", "description": "The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved." }, { "name": "team_member_id", "value": "", "type": "query", "description": "The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved." }, { "name": "location_id", "value": "", "type": "query", "description": "The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved." }, { "name": "start_at_min", "value": "", "type": "query", "description": "The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used." }, { "name": "start_at_max", "value": "", "type": "query", "description": "The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve a collection of bookings.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Create Booking", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a booking.\n\nThe required input must include the following:\n- `Booking.location_id`\n- `Booking.start_at`\n- `Booking.AppointmentSegment.team_member_id`\n- `Booking.AppointmentSegment.service_variation_id`\n- `Booking.AppointmentSegment.service_variation_version`\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor c" }, { "info": { "name": "Square Search Availability", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/availability/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for availabilities for booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Bulk Retrieve Bookings", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/bulk-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk-Retrieves a list of bookings by booking IDs.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Retrieve Business Booking Profile", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/business-booking-profile", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a seller's booking profile." }, { "info": { "name": "Square List Location Booking Profiles", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/location-booking-profiles", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paged response." }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists location booking profiles of a seller." }, { "info": { "name": "Square Retrieve Location Booking Profile", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/location-booking-profiles/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to retrieve the booking profile." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a seller's location booking profile." }, { "info": { "name": "Square List Team Member Booking Profiles", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/team-member-booking-profiles", "params": [ { "name": "bookable_only", "value": "", "type": "query", "description": "Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paged response." }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results." }, { "name": "location_id", "value": "", "type": "query", "description": "Indicates whether to include only team members enabled at the given location in the returned result." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists booking profiles for team members." }, { "info": { "name": "Square Bulk Retrieve Team Member Booking Profiles", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/team-member-booking-profiles/bulk-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves one or more team members' booking profiles." }, { "info": { "name": "Square Retrieve Team Member Booking Profile", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/team-member-booking-profiles/:team_member_id", "params": [ { "name": "team_member_id", "value": "", "type": "path", "description": "The ID of the team member to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a team member's booking profile." }, { "info": { "name": "Square Retrieve Booking", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/:booking_id", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Update Booking", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/bookings/:booking_id", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the [Booking](entity:Booking) object representing the to-be-updated booking." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Cancel Booking", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/:booking_id/cancel", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels an existing booking.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." } ] }, { "info": { "name": "BookingCustomAttributes", "type": "folder" }, "items": [ { "info": { "name": "Square List Booking Custom Attribute Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all bookings custom attribute definitions.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Create Booking Custom Attribute Definition", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Retrieve Booking Custom Attribute Definition", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Update Booking Custom Attribute Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Delete Booking Custom Attribute Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/bookings/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a bookings custom attribute definition.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Bulk Delete Booking Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/custom-attributes/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk deletes bookings custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Bulk Upsert Booking Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/bookings/custom-attributes/bulk-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk upserts bookings custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square List Booking Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/:booking_id/custom-attributes", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the target [booking](entity:Booking)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "with_definitions", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists a booking's custom attributes.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Retrieve Booking Custom Attribute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/bookings/:booking_id/custom-attributes/:key", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the target [booking](entity:Booking)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." }, { "name": "with_definition", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope." }, { "info": { "name": "Square Upsert Booking Custom Attribute", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/bookings/:booking_id/custom-attributes/:key", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the target [booking](entity:Booking)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upserts a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." }, { "info": { "name": "Square Delete Booking Custom Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/bookings/:booking_id/custom-attributes/:key", "params": [ { "name": "booking_id", "value": "", "type": "path", "description": "The ID of the target [booking](entity:Booking)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a bookings custom attribute.\n\nTo call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.\nTo call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.\n\nFor calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*\nor *Appointments Premium*." } ] }, { "info": { "name": "Cards", "type": "folder" }, "items": [ { "info": { "name": "Square List Cards", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/cards", "params": [ { "name": "cursor", "value": "", "type": "query", "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/build-basics/common-api-patterns/pagination) for more information." }, { "name": "customer_id", "value": "", "type": "query", "description": "Limit results to cards associated with the customer supplied.\nBy default, all cards owned by the merchant are returned." }, { "name": "include_disabled", "value": "", "type": "query", "description": "Includes disabled cards.\nBy default, all enabled cards owned by the merchant are returned." }, { "name": "reference_id", "value": "", "type": "query", "description": "Limit results to cards associated with the reference_id supplied." }, { "name": "sort_order", "value": "", "type": "query", "description": "Sorts the returned list by when the card was created with the specified order.\nThis field defaults to ASC." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of cards owned by the account making the request.\nA max of 25 cards will be returned." }, { "info": { "name": "Square Create Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/cards", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds a card on file to an existing merchant." }, { "info": { "name": "Square Retrieve Card", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "Unique ID for the desired Card." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves details for a specific Card." }, { "info": { "name": "Square Disable Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/cards/:card_id/disable", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "Unique ID for the desired Card." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Disables the card, preventing any further updates or charges.\nDisabling an already disabled card is allowed but has no effect." } ] }, { "info": { "name": "CashDrawers", "type": "folder" }, "items": [ { "info": { "name": "Square List Cash Drawer Shifts", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/cash-drawers/shifts", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location to query for a list of cash drawer shifts." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which cash drawer shifts are listed in the response,\nbased on their opened_at field. Default value: ASC" }, { "name": "begin_time", "value": "", "type": "query", "description": "The inclusive start time of the query on opened_at, in ISO 8601 format." }, { "name": "end_time", "value": "", "type": "query", "description": "The exclusive end date of the query on opened_at, in ISO 8601 format." }, { "name": "limit", "value": "", "type": "query", "description": "Number of cash drawer shift events in a page of results (200 by\ndefault, 1000 max)." }, { "name": "cursor", "value": "", "type": "query", "description": "Opaque cursor for fetching the next page of results." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides the details for all of the cash drawer shifts for a location\nin a date range." }, { "info": { "name": "Square Retrieve Cash Drawer Shift", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/cash-drawers/shifts/:shift_id", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location to retrieve cash drawer shifts from." }, { "name": "shift_id", "value": "", "type": "path", "description": "The shift ID." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides the summary details for a single cash drawer shift. See\n[ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events." }, { "info": { "name": "Square List Cash Drawer Shift Events", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/cash-drawers/shifts/:shift_id/events", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location to list cash drawer shifts for." }, { "name": "shift_id", "value": "", "type": "path", "description": "The shift ID." }, { "name": "limit", "value": "", "type": "query", "description": "Number of resources to be returned in a page of results (200 by\ndefault, 1000 max)." }, { "name": "cursor", "value": "", "type": "query", "description": "Opaque cursor for fetching the next page of results." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides a paginated list of events for a single cash drawer shift." } ] }, { "info": { "name": "Catalog", "type": "folder" }, "items": [ { "info": { "name": "Square Batch Delete Catalog Objects", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/batch-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a set of [CatalogItem](entity: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](entity:CatalogItemVariation)\nchildren.\n\n`BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted\nIDs can be deleted. The response will only incl" }, { "info": { "name": "Square Batch Retrieve Catalog Objects", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/batch-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a set of objects based on the provided ID.\nEach [CatalogItem](entity:CatalogItem) returned in the set includes all of its\nchild information including: all of its\n[CatalogItemVariation](entity:CatalogItemVariation) objects, references to\nits [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it." }, { "info": { "name": "Square Batch Upsert Catalog Objects", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/batch-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates up to 10,000 target objects based on the provided\nlist of objects. The target objects are grouped into batches and each batch is\ninserted/updated in an all-or-nothing manner. If an object within a batch is\nmalformed in some way, or violates a database constraint, the entire batch\ncontaining that item will be disregarded. However, other batches in the same\nrequest may still succeed. Each batch may contain up to 1,000 objects, and\nbatches will be processed in order as long as th" }, { "info": { "name": "Square Create Catalog Image", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/images", "body": { "type": "multipart-form", "data": [ { "name": "request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing\n[CatalogObject](entity:CatalogObject) instance. The resulting `CatalogImage` is unattached to any `CatalogObject` if the `object_id`\nis not specified.\n\nThis `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB." }, { "info": { "name": "Square Update Catalog Image", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/catalog/images/:image_id", "params": [ { "name": "image_id", "value": "", "type": "path", "description": "The ID of the `CatalogImage` object to update the encapsulated image file." } ], "body": { "type": "multipart-form", "data": [ { "name": "request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads a new image file to replace the existing one in the specified [CatalogImage](entity:CatalogImage) object.\n\nThis `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in\nJPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB." }, { "info": { "name": "Square Catalog Info", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/catalog/info", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves information about the Square Catalog API, such as batch size\nlimits that can be used by the `BatchUpsertCatalogObjects` endpoint." }, { "info": { "name": "Square List Catalog", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/catalog/list", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nThe page size is currently set to be 100.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." }, { "name": "types", "value": "", "type": "query", "description": "An optional case-insensitive, comma-separated list of object types to retrieve.\n\nThe valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,\n`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,\n`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS." }, { "name": "catalog_version", "value": "", "type": "query", "description": "The specific version of the catalog objects to be included in the response.\nThis allows you to retrieve historical versions of objects. The specified version value is matched against\nthe [CatalogObject](entity:CatalogObject)s' `version` attribute. If not included, results will be from the\ncurrent version of the catalog." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of all [CatalogObject](entity:CatalogObject)s of the specified types in the catalog.\n\nThe `types` parameter is specified as a comma-separated list of the [CatalogObjectType](entity:CatalogObjectType) values,\nfor example, \"`ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`\".\n\n__Important:__ ListCatalog does not return deleted catalog items. To retrieve\ndeleted catalog items, use [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObje" }, { "info": { "name": "Square Upsert Catalog Object", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/object", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new or updates the specified [CatalogObject](entity:CatalogObject).\n\nTo ensure consistency, only one update request is processed at a time per seller account.\nWhile one (batch or non-batch) update request is being processed, other (batched and non-batched)\nupdate requests are rejected with the `429` error code." }, { "info": { "name": "Square Retrieve Catalog Object", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/catalog/object/:object_id", "params": [ { "name": "object_id", "value": "", "type": "path", "description": "The object ID of any type of catalog objects to be retrieved." }, { "name": "include_related_objects", "value": "", "type": "query", "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field\nof the response. These objects are put in the `related_objects` field. Setting this to `true` is\nhelpful when the objects are needed for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included. For example,\n\nif the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`" }, { "name": "catalog_version", "value": "", "type": "query", "description": "Requests objects as of a specific version of the catalog. This allows you to retrieve historical\nversions of objects. The value to retrieve a specific version of an object can be found\nin the version field of [CatalogObject](entity:CatalogObject)s. If not included, results will\nbe from the current version of the catalog." }, { "name": "include_category_path_to_root", "value": "", "type": "query", "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists\nof `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category\nand ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned\nin the response payload." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a single [CatalogItem](entity:CatalogItem) as a\n[CatalogObject](entity:CatalogObject) based on the provided ID. The returned\nobject includes all of the relevant [CatalogItem](entity:CatalogItem)\ninformation including: [CatalogItemVariation](entity:CatalogItemVariation)\nchildren, references to its\n[CatalogModifierList](entity:CatalogModifierList) objects, and the ids of\nany [CatalogTax](entity:CatalogTax) objects that apply to it." }, { "info": { "name": "Square Delete Catalog Object", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/catalog/object/:object_id", "params": [ { "name": "object_id", "value": "", "type": "path", "description": "The ID of the catalog object to be deleted. When an object is deleted, other\nobjects in the graph that depend on that object will be deleted as well (for example, deleting a\ncatalog item will delete its catalog item variations)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a single [CatalogObject](entity:CatalogObject) based on the\nprovided ID and returns the set of successfully deleted IDs in the response.\nDeletion is a cascading event such that all children of the targeted object\nare also deleted. For example, deleting a [CatalogItem](entity:CatalogItem)\nwill also delete all of its\n[CatalogItemVariation](entity:CatalogItemVariation) children.\n\nTo ensure consistency, only one delete request is processed at a time per seller account.\nWhile one (batch or no" }, { "info": { "name": "Square Search Catalog Objects", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for [CatalogObject](entity:CatalogObject) of any type by matching supported search attribute values,\nexcluding custom attribute values on items or item variations, against one or more of the specified query filters.\n\nThis (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any t" }, { "info": { "name": "Square Search Catalog Items", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/search-catalog-items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for catalog items or item variations by matching supported search attribute values, including\ncustom attribute values, against one or more of the specified query filters.\n\nThis (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects)\nendpoint in the following aspects:\n\n- `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects.\n- `SearchCatalogIte" }, { "info": { "name": "Square Update Item Modifier Lists", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/update-item-modifier-lists", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the [CatalogModifierList](entity:CatalogModifierList) objects\nthat apply to the targeted [CatalogItem](entity:CatalogItem) without having\nto perform an upsert on the entire item." }, { "info": { "name": "Square Update Item Taxes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/catalog/update-item-taxes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the [CatalogTax](entity:CatalogTax) objects that apply to the\ntargeted [CatalogItem](entity:CatalogItem) without having to perform an\nupsert on the entire item." } ] }, { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Square List Customers", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "sort_field", "value": "", "type": "query", "description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`." }, { "name": "count", "value": "", "type": "query", "description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists customer profiles associated with a Square account.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or longer, especially during network incidents and outages." }, { "info": { "name": "Square Create Customer", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new customer for a business.\n\nYou must provide at least one of the following values in your request to this\nendpoint:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`" }, { "info": { "name": "Square Bulk Create Customers", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/bulk-create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates multiple [customer profiles](entity:Customer) for a business.\n\nThis endpoint takes a map of individual create requests and returns a map of responses.\n\nYou must provide at least one of the following values in each create request:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`" }, { "info": { "name": "Square Bulk Delete Customers", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes multiple customer profiles.\n\nThe endpoint takes a list of customer IDs and returns a map of responses." }, { "info": { "name": "Square Bulk Retrieve Customers", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/bulk-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves multiple customer profiles.\n\nThis endpoint takes a list of customer IDs and returns a map of responses." }, { "info": { "name": "Square Bulk Update Customers", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/bulk-update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates multiple customer profiles.\n\nThis endpoint takes a map of individual update requests and returns a map of responses." }, { "info": { "name": "Square Search Customers", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches the customer profiles associated with a Square account using one or more supported query filters.\n\nCalling `SearchCustomers` without any explicit query filter returns all\ncustomer profiles ordered alphabetically based on `given_name` and\n`family_name`.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the search operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or l" }, { "info": { "name": "Square Retrieve Customer", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns details for a single customer." }, { "info": { "name": "Square Update Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null`.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile." }, { "info": { "name": "Square Delete Customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer to delete." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a customer profile from a business.\n\nTo delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile." }, { "info": { "name": "Square Create Customer Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/:customer_id/cards", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The Square ID of the customer profile the card is linked to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds a card on file to an existing customer.\n\nAs with charges, calls to `CreateCustomerCard` are idempotent. Multiple\ncalls with the same card nonce return the same card record that was created\nwith the provided nonce during the _first_ call." }, { "info": { "name": "Square Delete Customer Card", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/:customer_id/cards/:card_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer that the card on file belongs to." }, { "name": "card_id", "value": "", "type": "path", "description": "The ID of the card on file to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a card on file from a customer." }, { "info": { "name": "Square Add Group to Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/customers/:customer_id/groups/:group_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer to add to a group." }, { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to add the customer to." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds a group membership to a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value." }, { "info": { "name": "Square Remove Group from Customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/:customer_id/groups/:group_id", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the customer to remove from the group." }, { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to remove the customer from." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a group membership from a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value." } ] }, { "info": { "name": "CustomerCustomAttributes", "type": "folder" }, "items": [ { "info": { "name": "Square List Customer Custom Attribute Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_" }, { "info": { "name": "Square Create Customer Custom Attribute Definition", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with customer profiles.\n\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or\n[BulkUpsertCust" }, { "info": { "name": "Square Retrieve Customer Custom Attribute Definition", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Update Customer Custom Attribute Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\n\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view\nall custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`." }, { "info": { "name": "Square Delete Customer Custom Attribute Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall customer profiles in the seller's Customer Directory.\n\nOnly the definition owner can delete a custom attribute definition." }, { "info": { "name": "Square Bulk Upsert Customer Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/custom-attributes/bulk-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation.\n\nUse this endpoint to set the value of one or more custom attributes for one or more customer profiles.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.\n\nThis `BulkUpsertCustomerCustomAttributes` " }, { "info": { "name": "Square List Customer Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/:customer_id/custom-attributes", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the target [customer profile](entity:Customer)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "with_definitions", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Retrieve Customer Custom Attribute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/:customer_id/custom-attributes/:key", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the target [customer profile](entity:Customer)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." }, { "name": "with_definition", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Upsert Customer Custom Attribute", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/:customer_id/custom-attributes/:key", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the target [customer profile](entity:Customer)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile.\n\nUse this endpoint to set the value of a custom attribute for a specified customer profile.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.\n\nTo create or update a custom attribute owned by another application, the" }, { "info": { "name": "Square Delete Customer Custom Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/:customer_id/custom-attributes/:key", "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The ID of the target [customer profile](entity:Customer)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." } ] }, { "info": { "name": "CustomerGroups", "type": "folder" }, "items": [ { "info": { "name": "Square List Customer Groups", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/groups", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the list of customer groups of a business." }, { "info": { "name": "Square Create Customer Group", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new customer group for a business.\n\nThe request must include the `name` value of the group." }, { "info": { "name": "Square Retrieve Customer Group", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific customer group as identified by the `group_id` value." }, { "info": { "name": "Square Update Customer Group", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a customer group as identified by the `group_id` value." }, { "info": { "name": "Square Delete Customer Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a customer group as identified by the `group_id` value." } ] }, { "info": { "name": "CustomerSegments", "type": "folder" }, "items": [ { "info": { "name": "Square List Customer Segments", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/segments", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the list of customer segments of a business." }, { "info": { "name": "Square Retrieve Customer Segment", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/segments/:segment_id", "params": [ { "name": "segment_id", "value": "", "type": "path", "description": "The Square-issued ID of the customer segment." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific customer segment as identified by the `segment_id` value." } ] }, { "info": { "name": "Devices", "type": "folder" }, "items": [ { "info": { "name": "Square List Devices", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/devices", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)." }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return in a single page." }, { "name": "location_id", "value": "", "type": "query", "description": "If present, only returns devices at the target location." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List devices associated with the merchant. Currently, only Terminal API\ndevices are supported." }, { "info": { "name": "Square List Device Codes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/devices/codes", "params": [ { "name": "cursor", "value": "", "type": "query", "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 [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." }, { "name": "location_id", "value": "", "type": "query", "description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty." }, { "name": "product_type", "value": "", "type": "query", "description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty." }, { "name": "status", "value": "", "type": "query", "description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all DeviceCodes associated with the merchant." }, { "info": { "name": "Square Create Device Code", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/devices/codes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected\nterminal mode." }, { "info": { "name": "Square Get Device Code", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/devices/codes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the device code." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves DeviceCode with the associated ID." }, { "info": { "name": "Square Get Device", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "The unique ID for the desired `Device`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves Device with the associated `device_id`." } ] }, { "info": { "name": "Disputes", "type": "folder" }, "items": [ { "info": { "name": "Square List Disputes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/disputes", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "states", "value": "", "type": "query", "description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes." }, { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of disputes associated with a particular account." }, { "info": { "name": "Square Retrieve Dispute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/disputes/:dispute_id", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute you want more details about." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns details about a specific dispute." }, { "info": { "name": "Square Accept Dispute", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/accept", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute you want to accept." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and\nupdates the dispute state to ACCEPTED.\n\nSquare debits the disputed amount from the seller’s Square account. If the Square account\ndoes not have sufficient funds, Square debits the associated bank account." }, { "info": { "name": "Square List Dispute Evidence", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of evidence associated with a dispute." }, { "info": { "name": "Square Create Dispute Evidence File", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence-files", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute for which you want to upload evidence." } ], "body": { "type": "multipart-form", "data": [ { "name": "request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP\nmultipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats." }, { "info": { "name": "Square Create Dispute Evidence Text", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence-text", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute for which you want to upload evidence." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads text to use as evidence for a dispute challenge." }, { "info": { "name": "Square Retrieve Dispute Evidence", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence/:evidence_id", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute from which you want to retrieve evidence metadata." }, { "name": "evidence_id", "value": "", "type": "path", "description": "The ID of the evidence to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the metadata for the evidence specified in the request URL path.\n\nYou must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it." }, { "info": { "name": "Square Delete Dispute Evidence", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence/:evidence_id", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute from which you want to remove evidence." }, { "name": "evidence_id", "value": "", "type": "path", "description": "The ID of the evidence you want to remove." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes specified evidence from a dispute.\nSquare does not send the bank any evidence that is removed." }, { "info": { "name": "Square Submit Evidence", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/disputes/:dispute_id/submit-evidence", "params": [ { "name": "dispute_id", "value": "", "type": "path", "description": "The ID of the dispute for which you want to submit evidence." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Submits evidence to the cardholder's bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and\n[CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission." } ] }, { "info": { "name": "Employees", "type": "folder" }, "items": [ { "info": { "name": "Square List Employees", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/employees", "params": [ { "name": "location_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Specifies the EmployeeStatus to filter the employee by." }, { "name": "limit", "value": "", "type": "query", "description": "The number of employees to be returned on each page." }, { "name": "cursor", "value": "", "type": "query", "description": "The token required to retrieve the specified page of results." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Square List Employees" }, { "info": { "name": "Square Retrieve Employee", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/employees/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "UUID for the employee that was requested." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Square Retrieve Employee" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Square Search Events", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Search for Square API events that occur within a 28-day timeframe." }, { "info": { "name": "Square Disable Events", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/events/disable", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Disables events to prevent them from being searchable.\nAll events are disabled by default. You must enable events to make them searchable.\nDisabling events for a specific time period prevents them from being searchable, even if you re-enable them later." }, { "info": { "name": "Square Enable Events", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/events/enable", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables events to make them searchable. Only events that occur while in the enabled state are searchable." }, { "info": { "name": "Square List Event Types", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/events/types", "params": [ { "name": "api_version", "value": "", "type": "query", "description": "The API version for which to list event types. Setting this field overrides the default version used by the application." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all event types that you can subscribe to as webhooks or query using the Events API." } ] }, { "info": { "name": "GiftCards", "type": "folder" }, "items": [ { "info": { "name": "Square List Gift Cards", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/gift-cards", "params": [ { "name": "type", "value": "", "type": "query", "description": "If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.\nOtherwise, the endpoint returns gift cards of all types." }, { "name": "state", "value": "", "type": "query", "description": "If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.\nOtherwise, the endpoint returns the gift cards of all states." }, { "name": "limit", "value": "", "type": "query", "description": "If a limit is provided, the endpoint returns only the specified number of results per page.\nThe maximum value is 200. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "customer_id", "value": "", "type": "query", "description": "If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all gift cards. You can specify optional filters to retrieve \na subset of the gift cards. Results are sorted by `created_at` in ascending order." }, { "info": { "name": "Square Create Gift Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card\nhas a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE`\nactivity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment)\nto refund a payment to the new gift card." }, { "info": { "name": "Square Retrieve Gift Card from GAN", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards/from-gan", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a gift card using the gift card account number (GAN)." }, { "info": { "name": "Square Retrieve Gift Card from Nonce", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards/from-nonce", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a gift card using a secure payment token that represents the gift card." }, { "info": { "name": "Square Link Customer to Gift Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards/:gift_card_id/link-customer", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "The ID of the gift card to be linked." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Links a customer to a gift card, which is also referred to as adding a card on file." }, { "info": { "name": "Square Unlink Customer from Gift Card", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards/:gift_card_id/unlink-customer", "params": [ { "name": "gift_card_id", "value": "", "type": "path", "description": "The ID of the gift card to be unlinked." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unlinks a customer from a gift card, which is also referred to as removing a card on file." }, { "info": { "name": "Square Retrieve Gift Card", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/gift-cards/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the gift card to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a gift card using the gift card ID." } ] }, { "info": { "name": "GiftCardActivities", "type": "folder" }, "items": [ { "info": { "name": "Square List Gift Card Activities", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/gift-cards/activities", "params": [ { "name": "gift_card_id", "value": "", "type": "query", "description": "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller." }, { "name": "type", "value": "", "type": "query", "description": "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities." }, { "name": "location_id", "value": "", "type": "query", "description": "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations." }, { "name": "begin_time", "value": "", "type": "query", "description": "The timestamp for the beginning of the reporting period, in RFC 3339 format.\nThis start time is inclusive. The default value is the current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "The timestamp for the end of the reporting period, in RFC 3339 format.\nThis end time is inclusive. The default value is the current time." }, { "name": "limit", "value": "", "type": "query", "description": "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which the endpoint returns the activities, based on `created_at`.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists gift card activities. By default, you get gift card activities for all\ngift cards in the seller's account. You can optionally specify query parameters to\nfilter the list. For example, you can get a list of gift card activities for a gift card,\nfor all gift cards in a specific region, or for activities within a time window." }, { "info": { "name": "Square Create Gift Card Activity", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/gift-cards/activities", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard).\nFor example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use." } ] }, { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "Square Deprecated Retrieve Inventory Adjustment", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/adjustment/:adjustment_id", "params": [ { "name": "adjustment_id", "value": "", "type": "path", "description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL\nis updated to conform to the standard convention." }, { "info": { "name": "Square Retrieve Inventory Adjustment", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/adjustments/:adjustment_id", "params": [ { "name": "adjustment_id", "value": "", "type": "path", "description": "ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the [InventoryAdjustment](entity:InventoryAdjustment) object\nwith the provided `adjustment_id`." }, { "info": { "name": "Square Deprecated Batch Change Inventory", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/batch-change", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL\nis updated to conform to the standard convention." }, { "info": { "name": "Square Deprecated Batch Retrieve Inventory Changes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/batch-retrieve-changes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL\nis updated to conform to the standard convention." }, { "info": { "name": "Square Deprecated Batch Retrieve Inventory Counts", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/batch-retrieve-counts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL\nis updated to conform to the standard convention." }, { "info": { "name": "Square Batch Change Inventory", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/changes/batch-create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Applies adjustments and counts to the provided item quantities.\n\nOn success: returns the current calculated counts for all objects\nreferenced in the request.\nOn failure: returns a list of related errors." }, { "info": { "name": "Square Batch Retrieve Inventory Changes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/changes/batch-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns historical physical counts and adjustments based on the\nprovided filter criteria.\n\nResults are paginated and sorted in ascending order according their\n`occurred_at` timestamp (oldest first).\n\nBatchRetrieveInventoryChanges is a catch-all query endpoint for queries\nthat cannot be handled by other, simpler endpoints." }, { "info": { "name": "Square Batch Retrieve Inventory Counts", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/inventory/counts/batch-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns current counts for the provided\n[CatalogObject](entity:CatalogObject)s at the requested\n[Location](entity:Location)s.\n\nResults are paginated and sorted in descending order according to their\n`calculated_at` timestamp (newest first).\n\nWhen `updated_after` is specified, only counts that have changed since that\ntime (based on the server timestamp for the most recent change) are\nreturned. This allows clients to perform a \"sync\" operation, for example\nin response to receiving a Webhook notifi" }, { "info": { "name": "Square Deprecated Retrieve Inventory Physical Count", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/physical-count/:physical_count_id", "params": [ { "name": "physical_count_id", "value": "", "type": "path", "description": "ID of the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL\nis updated to conform to the standard convention." }, { "info": { "name": "Square Retrieve Inventory Physical Count", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/physical-counts/:physical_count_id", "params": [ { "name": "physical_count_id", "value": "", "type": "path", "description": "ID of the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount)\nobject with the provided `physical_count_id`." }, { "info": { "name": "Square Retrieve Inventory Transfer", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/transfers/:transfer_id", "params": [ { "name": "transfer_id", "value": "", "type": "path", "description": "ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the [InventoryTransfer](entity:InventoryTransfer) object\nwith the provided `transfer_id`." }, { "info": { "name": "Square Retrieve Inventory Count", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/:catalog_object_id", "params": [ { "name": "catalog_object_id", "value": "", "type": "path", "description": "ID of the [CatalogObject](entity:CatalogObject) to retrieve." }, { "name": "location_ids", "value": "", "type": "query", "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the current calculated stock count for a given\n[CatalogObject](entity:CatalogObject) at a given set of\n[Location](entity:Location)s. Responses are paginated and unsorted.\nFor more sophisticated queries, use a batch endpoint." }, { "info": { "name": "Square Retrieve Inventory Changes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/inventory/:catalog_object_id/changes", "params": [ { "name": "catalog_object_id", "value": "", "type": "path", "description": "ID of the [CatalogObject](entity:CatalogObject) to retrieve." }, { "name": "location_ids", "value": "", "type": "query", "description": "The [Location](entity:Location) IDs to look up as a comma-separated\nlist. An empty list queries all locations." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for the original query.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a set of physical counts and inventory adjustments for the\nprovided [CatalogObject](entity:CatalogObject) at the requested\n[Location](entity:Location)s.\n\nYou can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges)\nand having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.\n\nResults are paginated and sorted in descending order according to their\n`occurred_at` timestamp (newest first).\n\nTh" } ] }, { "info": { "name": "Invoices", "type": "folder" }, "items": [ { "info": { "name": "Square List Invoices", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/invoices", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location for which to list invoices." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint. \nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of invoices to return (200 is the maximum `limit`). \nIf not provided, the server uses a default limit of 100 invoices." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of invoices for a given location. The response \nis paginated. If truncated, the response includes a `cursor` that you \nuse in a subsequent request to retrieve the next set of invoices." }, { "info": { "name": "Square Create Invoice", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/invoices", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a draft [invoice](entity:Invoice) \nfor an order created using the Orders API.\n\nA draft invoice remains in your account and no action is taken. \nYou must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file)." }, { "info": { "name": "Square Search Invoices", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/invoices/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for invoices from a location specified in \nthe filter. You can optionally specify customers in the filter for whom to \nretrieve invoices. In the current implementation, you can only specify one location and \noptionally one customer.\n\nThe response is paginated. If truncated, the response includes a `cursor` \nthat you use in a subsequent request to retrieve the next set of invoices." }, { "info": { "name": "Square Get Invoice", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the invoice to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an invoice by invoice ID." }, { "info": { "name": "Square Update Invoice", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the invoice to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an invoice. This endpoint supports sparse updates, so you only need\nto specify the fields you want to change along with the required `version` field.\nSome restrictions apply to updating invoices. For example, you cannot change the\n`order_id` or `location_id` field." }, { "info": { "name": "Square Delete Invoice", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the invoice to delete." }, { "name": "version", "value": "", "type": "query", "description": "The version of the [invoice](entity:Invoice) to delete.\nIf you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or \n[ListInvoices](api-endpoint:Invoices-ListInvoices)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes the specified invoice. When an invoice is deleted, the \nassociated order status changes to CANCELED. You can only delete a draft \ninvoice (you cannot delete a published invoice, including one that is scheduled for processing)." }, { "info": { "name": "Square Create Invoice Attachment", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/invoices/:invoice_id/attachments", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the [invoice](entity:Invoice) to attach the file to." } ], "body": { "type": "multipart-form", "data": [ { "name": "request", "type": "text", "value": "" }, { "name": "image_file", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads\nwith a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that contains a file\nin a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.\n\nInvoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added only to invoices\nin the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state." }, { "info": { "name": "Square Delete Invoice Attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/invoices/:invoice_id/attachments/:attachment_id", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the [invoice](entity:Invoice) to delete the attachment from." }, { "name": "attachment_id", "value": "", "type": "path", "description": "The ID of the [attachment](entity:InvoiceAttachment) to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only\nfrom invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state." }, { "info": { "name": "Square Cancel Invoice", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/invoices/:invoice_id/cancel", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the [invoice](entity:Invoice) to cancel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels an invoice. The seller cannot collect payments for \nthe canceled invoice.\n\nYou cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`." }, { "info": { "name": "Square Publish Invoice", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/invoices/:invoice_id/publish", "params": [ { "name": "invoice_id", "value": "", "type": "path", "description": "The ID of the invoice to publish." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Publishes the specified draft invoice. \n\nAfter an invoice is published, Square \nfollows up based on the invoice configuration. For example, Square \nsends the invoice to the customer's email address, charges the customer's card on file, or does \nnothing. Square also makes the invoice available on a Square-hosted invoice page. \n\nThe invoice `status` also changes from `DRAFT` to a status \nbased on the invoice configuration. For example, the status changes to `UNPAID` if \nSquare emails the invoice o" } ] }, { "info": { "name": "Labor", "type": "folder" }, "items": [ { "info": { "name": "Square List Break Types", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/break-types", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200." }, { "name": "cursor", "value": "", "type": "query", "description": "A pointer to the next page of `BreakType` results to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of `BreakType` instances for a business." }, { "info": { "name": "Square Create Break Type", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/labor/break-types", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new `BreakType`.\n\nA `BreakType` is a template for creating `Break` objects.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `break_name`\n- `expected_duration`\n- `is_paid`\n\nYou can only have three `BreakType` instances per location. If you attempt to add a fourth\n`BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\"\nis returned." }, { "info": { "name": "Square Get Break Type", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/break-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `BreakType` being retrieved." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a single `BreakType` specified by `id`." }, { "info": { "name": "Square Update Break Type", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/labor/break-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": " The UUID for the `BreakType` being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing `BreakType`." }, { "info": { "name": "Square Delete Break Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/labor/break-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `BreakType` being deleted." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an existing `BreakType`.\n\nA `BreakType` can be deleted even if it is referenced from a `Shift`." }, { "info": { "name": "Square List Employee Wages", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/employee-wages", "params": [ { "name": "employee_id", "value": "", "type": "query", "description": "Filter the returned wages to only those that are associated with the specified employee." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200." }, { "name": "cursor", "value": "", "type": "query", "description": "A pointer to the next page of `EmployeeWage` results to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of `EmployeeWage` instances for a business." }, { "info": { "name": "Square Get Employee Wage", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/employee-wages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `EmployeeWage` being retrieved." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a single `EmployeeWage` specified by `id`." }, { "info": { "name": "Square Create Shift", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/labor/shifts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new `Shift`.\n\nA `Shift` represents a complete workday for a single team member.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `team_member_id`\n- `start_at`\n\nAn attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:\n- The `status` of the new `Shift` is `OPEN` and the team member has another\nshift with an `OPEN` status.\n- The `start_at` date is in the future.\n- The `start_at` or `end_at` date overlaps another shift for the s" }, { "info": { "name": "Square Search Shifts", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/labor/shifts/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of `Shift` records for a business.\nThe list to be returned can be filtered by:\n- Location IDs\n- Team member IDs\n- Shift status (`OPEN` or `CLOSED`)\n- Shift start\n- Shift end\n- Workday details\n\nThe list can be sorted by:\n- `START_AT`\n- `END_AT`\n- `CREATED_AT`\n- `UPDATED_AT`" }, { "info": { "name": "Square Get Shift", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/shifts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `Shift` being retrieved." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a single `Shift` specified by `id`." }, { "info": { "name": "Square Update Shift", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/labor/shifts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the object being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing `Shift`.\n\nWhen adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have\nthe `end_at` property set to a valid RFC-3339 datetime string.\n\nWhen closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`\nset on each `Break`." }, { "info": { "name": "Square Delete Shift", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/labor/shifts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `Shift` being deleted." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a `Shift`." }, { "info": { "name": "Square List Team Member Wages", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/team-member-wages", "params": [ { "name": "team_member_id", "value": "", "type": "query", "description": "Filter the returned wages to only those that are associated with the\nspecified team member." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200." }, { "name": "cursor", "value": "", "type": "query", "description": "A pointer to the next page of `EmployeeWage` results to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of `TeamMemberWage` instances for a business." }, { "info": { "name": "Square Get Team Member Wage", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/team-member-wages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `TeamMemberWage` being retrieved." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a single `TeamMemberWage` specified by `id`." }, { "info": { "name": "Square List Workweek Configs", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/labor/workweek-configs", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of `WorkweekConfigs` results to return per page." }, { "name": "cursor", "value": "", "type": "query", "description": "A pointer to the next page of `WorkweekConfig` results to fetch." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of `WorkweekConfig` instances for a business." }, { "info": { "name": "Square Update Workweek Config", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/labor/workweek-configs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID for the `WorkweekConfig` object being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a `WorkweekConfig`." } ] }, { "info": { "name": "Locations", "type": "folder" }, "items": [ { "info": { "name": "Square List Locations", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),\nincluding those with an inactive status. Locations are listed alphabetically by `name`." }, { "info": { "name": "Square Create Location", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a [location](https://developer.squareup.com/docs/locations-api).\nCreating new locations allows for separate configuration of receipt layouts, item prices,\nand sales reports. Developers can use locations to separate sales activity through applications\nthat integrate with Square from sales activity elsewhere in a seller's account.\nLocations created programmatically with the Locations API last forever and\nare visible to the seller for their own management. Therefore, ensure that\neach locati" }, { "info": { "name": "Square Retrieve Location", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to retrieve. Specify the string\n\"main\" to return the main location." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves details of a single location. Specify \"main\"\nas the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location)." }, { "info": { "name": "Square Update Location", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a [location](https://developer.squareup.com/docs/locations-api)." } ] }, { "info": { "name": "LocationCustomAttributes", "type": "folder" }, "items": [ { "info": { "name": "Square List Location Custom Attribute Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions", "params": [ { "name": "visibility_filter", "value": "", "type": "query", "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Create Location Custom Attribute Definition", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with locations.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) or\n[BulkUpsertLocationCusto" }, { "info": { "name": "Square Retrieve Location Custom Attribute Definition", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Update Location Custom Attribute Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition." }, { "info": { "name": "Square Delete Location Custom Attribute Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/locations/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nall locations.\nOnly the definition owner can delete a custom attribute definition." }, { "info": { "name": "Square Bulk Delete Location Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/custom-attributes/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes [custom attributes](entity:CustomAttribute) for locations as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Bulk Upsert Location Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/custom-attributes/bulk-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates [custom attributes](entity:CustomAttribute) for locations as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for one or more locations.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint.\nThis `BulkUpsertLocationCustomAttributes` endpoint accepts a" }, { "info": { "name": "Square List Location Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/custom-attributes", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the target [location](entity:Location)." }, { "name": "visibility_filter", "value": "", "type": "query", "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "with_definitions", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the [custom attributes](entity:CustomAttribute) associated with a location.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Retrieve Location Custom Attribute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/custom-attributes/:key", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the target [location](entity:Location)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." }, { "name": "with_definition", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a location.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Upsert Location Custom Attribute", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/custom-attributes/:key", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the target [location](entity:Location)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a [custom attribute](entity:CustomAttribute) for a location.\nUse this endpoint to set the value of a custom attribute for a specified location.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-CreateLocationCustomAttributeDefinition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` sett" }, { "info": { "name": "Square Delete Location Custom Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/locations/:location_id/custom-attributes/:key", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the target [location](entity:Location)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a [custom attribute](entity:CustomAttribute) associated with a location.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`." } ] }, { "info": { "name": "Checkout", "type": "folder" }, "items": [ { "info": { "name": "Square Create Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/checkouts", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the business location to associate the checkout with." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Links a `checkoutId` to a `checkout_page_url` that customers are\ndirected to in order to provide their payment information using a\npayment processing workflow hosted on connect.squareup.com. \n\n\nNOTE: The Checkout API has been updated with new features. \nFor more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights)." }, { "info": { "name": "Square Retrieve Location Settings", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/online-checkout/location-settings/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location for which to retrieve settings." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the location-level settings for a Square-hosted checkout page." }, { "info": { "name": "Square Update Location Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/online-checkout/location-settings/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location for which to retrieve settings." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the location-level settings for a Square-hosted checkout page." }, { "info": { "name": "Square Retrieve Merchant Settings", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/online-checkout/merchant-settings", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the merchant-level settings for a Square-hosted checkout page." }, { "info": { "name": "Square Update Merchant Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/online-checkout/merchant-settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the merchant-level settings for a Square-hosted checkout page." }, { "info": { "name": "Square List Payment Links", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/online-checkout/payment-links", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nIf a cursor is not provided, the endpoint returns the first page of the results.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of results to return per page. The limit is advisory and\nthe implementation might return more or less results. If the supplied limit is negative, zero, or\ngreater than the maximum limit of 1000, it is ignored.\n\nDefault value: `100`" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all payment links." }, { "info": { "name": "Square Create Payment Link", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/online-checkout/payment-links", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services." }, { "info": { "name": "Square Retrieve Payment Link", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/online-checkout/payment-links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of link to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a payment link." }, { "info": { "name": "Square Update Payment Link", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/online-checkout/payment-links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the payment link to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a payment link. You can update the `payment_link` fields such as\n`description`, `checkout_options`, and `pre_populated_data`.\nYou cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field." }, { "info": { "name": "Square Delete Payment Link", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/online-checkout/payment-links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the payment link to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a payment link." } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "Square List Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to list transactions for." }, { "name": "begin_time", "value": "", "type": "query", "description": "The beginning of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "The end of the requested reporting period, in RFC 3339 format.\n\nSee [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.\n\nDefault value: The current time." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which results are listed in the response (`ASC` for\noldest first, `DESC` for newest first).\n\nDefault value: `DESC`" }, { "name": "cursor", "value": "", "type": "query", "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 [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists transactions for a particular location.\n\nTransactions include payment information from sales and exchanges and refund\ninformation from returns and exchanges.\n\nMax results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50" }, { "info": { "name": "Square Retrieve Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the transaction's associated location." }, { "name": "transaction_id", "value": "", "type": "path", "description": "The ID of the transaction to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves details for a single transaction." }, { "info": { "name": "Square Capture Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id/capture", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "transaction_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information." }, { "info": { "name": "Square Void Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/locations/:location_id/transactions/:transaction_id/void", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "transaction_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)\nendpoint with a `delay_capture` value of `true`.\n\n\nSee [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture)\nfor more information." } ] }, { "info": { "name": "Loyalty", "type": "folder" }, "items": [ { "info": { "name": "Square Create Loyalty Account", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/accounts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer." }, { "info": { "name": "Square Search Loyalty Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/accounts/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for loyalty accounts in a loyalty program.\n\nYou can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely.\n\nSearch results are sorted by `created_at` in ascending order." }, { "info": { "name": "Square Retrieve Loyalty Account", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a loyalty account." }, { "info": { "name": "Square Accumulate Loyalty Points", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/accounts/:account_id/accumulate", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The ID of the target [loyalty account](entity:LoyaltyAccount)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds points earned from a purchase to a [loyalty account](entity:LoyaltyAccount).\n\n- If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order\nto compute the points earned from both the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual\nrules, Square computes points based on the accrual rule that grants the most points.\nFor purchases that qualify for multiple promotions, Squar" }, { "info": { "name": "Square Adjust Loyalty Points", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/accounts/:account_id/adjust", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The ID of the target [loyalty account](entity:LoyaltyAccount)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds points to or subtracts points from a buyer's account.\n\nUse this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call\n[AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)\nto add points when a buyer pays for the purchase." }, { "info": { "name": "Square Search Loyalty Events", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/events/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for loyalty events.\n\nA Square loyalty program maintains a ledger of events that occur during the lifetime of a\nbuyer's loyalty account. Each change in the point balance\n(for example, points earned, points redeemed, and points expired) is\nrecorded in the ledger. Using this endpoint, you can search the ledger for events.\n\nSearch results are sorted by `created_at` in descending order." }, { "info": { "name": "Square List Loyalty Programs", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/programs", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of loyalty programs in the seller's account.\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).\n\n\nReplaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`." }, { "info": { "name": "Square Retrieve Loyalty Program", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id", "params": [ { "name": "program_id", "value": "", "type": "path", "description": "The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.\n\nLoyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview)." }, { "info": { "name": "Square Calculate Loyalty Points", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id/calculate", "params": [ { "name": "program_id", "value": "", "type": "path", "description": "The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint\nto display the points to the buyer.\n\n- If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.\nSquare reads the order to compute the points earned from the base loyalty program and an associated\n[loyalty promotion](entity:LoyaltyPromotion).\n\n- If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the\n" }, { "info": { "name": "Square List Loyalty Promotions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id/promotions", "params": [ { "name": "program_id", "value": "", "type": "path", "description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword." }, { "name": "status", "value": "", "type": "query", "description": "The status to filter the results by. If a status is provided, only loyalty promotions\nwith the specified status are returned. Otherwise, all loyalty promotions associated with\nthe loyalty program are returned." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response.\nThe minimum value is 1 and the maximum value is 30. The default value is 30.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the loyalty promotions associated with a [loyalty program](entity:LoyaltyProgram).\nResults are sorted by the `created_at` date in descending order (newest to oldest)." }, { "info": { "name": "Square Create Loyalty Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id/promotions", "params": [ { "name": "program_id", "value": "", "type": "path", "description": "The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion.\nTo get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)\nusing the `main` keyword." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a loyalty promotion for a [loyalty program](entity:LoyaltyProgram). A loyalty promotion\nenables buyers to earn points in addition to those earned from the base loyalty program.\n\nThis endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the\n`available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an\n`ACTIVE` or `SCHEDULED` status." }, { "info": { "name": "Square Retrieve Loyalty Promotion", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id/promotions/:promotion_id", "params": [ { "name": "promotion_id", "value": "", "type": "path", "description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve." }, { "name": "program_id", "value": "", "type": "path", "description": "The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,\ncall [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a loyalty promotion." }, { "info": { "name": "Square Cancel Loyalty Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/programs/:program_id/promotions/:promotion_id/cancel", "params": [ { "name": "promotion_id", "value": "", "type": "path", "description": "The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a\npromotion that has an `ACTIVE` or `SCHEDULED` status." }, { "name": "program_id", "value": "", "type": "path", "description": "The ID of the base [loyalty program](entity:LoyaltyProgram)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the\nend date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion.\nBecause updating a promotion is not supported, you can also use this endpoint to cancel a promotion before\nyou create a new one.\n\nThis endpoint sets the loyalty promotion to the `CANCELED` state" }, { "info": { "name": "Square Create Loyalty Reward", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/rewards", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a loyalty reward. In the process, the endpoint does following:\n\n- Uses the `reward_tier_id` in the request to determine the number of points\nto lock for this reward.\n- If the request includes `order_id`, it adds the reward and related discount to the order.\n\nAfter a reward is created, the points are locked and\nnot available for the buyer to redeem another reward." }, { "info": { "name": "Square Search Loyalty Rewards", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/rewards/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts.\nIf you include a `query` object, `loyalty_account_id` is required and `status` is optional.\n\nIf you know a reward ID, use the\n[RetrieveLoyaltyReward](api-endpoint:Loyalty-RetrieveLoyaltyReward) endpoint.\n\nSearch results are sorted by `updated_at` in descending order." }, { "info": { "name": "Square Retrieve Loyalty Reward", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/loyalty/rewards/:reward_id", "params": [ { "name": "reward_id", "value": "", "type": "path", "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a loyalty reward." }, { "info": { "name": "Square Delete Loyalty Reward", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/loyalty/rewards/:reward_id", "params": [ { "name": "reward_id", "value": "", "type": "path", "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a loyalty reward by doing the following:\n\n- Returns the loyalty points back to the loyalty account.\n- If an order ID was specified when the reward was created\n(see [CreateLoyaltyReward](api-endpoint:Loyalty-CreateLoyaltyReward)),\nit updates the order by removing the reward and related\ndiscounts.\n\nYou cannot delete a reward that has reached the terminal state (REDEEMED)." }, { "info": { "name": "Square Redeem Loyalty Reward", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/loyalty/rewards/:reward_id/redeem", "params": [ { "name": "reward_id", "value": "", "type": "path", "description": "The ID of the [loyalty reward](entity:LoyaltyReward) to redeem." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Redeems a loyalty reward.\n\nThe endpoint sets the reward to the `REDEEMED` terminal state.\n\nIf you are using your own order processing system (not using the\nOrders API), you call this endpoint after the buyer paid for the\npurchase.\n\nAfter the reward reaches the terminal state, it cannot be deleted.\nIn other words, points used for the reward cannot be returned\nto the account." } ] }, { "info": { "name": "Merchants", "type": "folder" }, "items": [ { "info": { "name": "Square List Merchants", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The cursor generated by the previous response." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Provides details about the merchant associated with a given access token.\n\nThe access token used to connect your application to a Square seller is associated\nwith a single merchant. That means that `ListMerchants` returns a list\nwith a single `Merchant` object. You can specify your personal access token\nto get your own merchant information or specify an OAuth token to get the\ninformation for the merchant that granted your application access.\n\nIf you know the merchant ID, you can also use the [Re" }, { "info": { "name": "Square Retrieve Merchant", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants/:merchant_id", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The ID of the merchant to retrieve. If the string \"me\" is supplied as the ID,\nthen retrieve the merchant that is currently accessible to this call." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the `Merchant` object for the given `merchant_id`." } ] }, { "info": { "name": "MerchantCustomAttributes", "type": "folder" }, "items": [ { "info": { "name": "Square List Merchant Custom Attribute Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions", "params": [ { "name": "visibility_filter", "value": "", "type": "query", "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the merchant-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Create Merchant Custom Attribute Definition", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to define a custom attribute that can be associated with a merchant connecting to your application.\nA custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties\nfor a custom attribute. After the definition is created, you can call\n[UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttrib" }, { "info": { "name": "Square Retrieve Merchant Custom Attribute Definition", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to retrieve. If the requesting application\nis not the definition owner, you must use the qualified key." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute definition, which is used for strongly consistent\nreads to guarantee that you receive the most up-to-date data. When included in the request,\nSquare returns the specified version or a higher version if one exists. If the specified version\nis higher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Update Merchant Custom Attribute Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.\nUse this endpoint to update the following fields: `name`, `description`, `visibility`, or the\n`schema` for a `Selection` data type.\nOnly the definition owner can update a custom attribute definition." }, { "info": { "name": "Square Delete Merchant Custom Attribute Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/merchants/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a merchant-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\nDeleting a custom attribute definition also deletes the corresponding custom attribute from\nthe merchant.\nOnly the definition owner can delete a custom attribute definition." }, { "info": { "name": "Square Bulk Delete Merchant Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/merchants/custom-attributes/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Bulk Upsert Merchant Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/merchants/custom-attributes/bulk-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates [custom attributes](entity:CustomAttribute) for a merchant as a bulk operation.\nUse this endpoint to set the value of one or more custom attributes for a merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which is\ncreated using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint.\nThis `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 " }, { "info": { "name": "Square List Merchant Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants/:merchant_id/custom-attributes", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The ID of the target [merchant](entity:Merchant)." }, { "name": "visibility_filter", "value": "", "type": "query", "description": "Filters the `CustomAttributeDefinition` results by their `visibility` values." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory.\nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.\nThe default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint.\nProvide this cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "with_definitions", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom\nattribute, information about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the [custom attributes](entity:CustomAttribute) associated with a merchant.\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Retrieve Merchant Custom Attribute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/merchants/:merchant_id/custom-attributes/:key", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The ID of the target [merchant](entity:Merchant)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." }, { "name": "with_definition", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`." }, { "name": "version", "value": "", "type": "query", "description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a [custom attribute](entity:CustomAttribute) associated with a merchant.\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Upsert Merchant Custom Attribute", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/merchants/:merchant_id/custom-attributes/:key", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The ID of the target [merchant](entity:Merchant)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to create or update. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a [custom attribute](entity:CustomAttribute) for a merchant.\nUse this endpoint to set the value of a custom attribute for a specified merchant.\nA custom attribute is based on a custom attribute definition in a Square seller account, which\nis created using the [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) endpoint.\nTo create or update a custom attribute owned by another application, the `visibility` sett" }, { "info": { "name": "Square Delete Merchant Custom Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/merchants/:merchant_id/custom-attributes/:key", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The ID of the target [merchant](entity:Merchant)." }, { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute to delete. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a [custom attribute](entity:CustomAttribute) associated with a merchant.\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`." } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Square Create Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new [order](entity:Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint." }, { "info": { "name": "Square Batch Retrieve Orders", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/batch-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a set of [orders](entity:Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error." }, { "info": { "name": "Square Calculate Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/calculate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables applications to preview order pricing without creating an order." }, { "info": { "name": "Square Clone Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/clone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has\nonly the core fields (such as line items, taxes, and discounts) copied from the original order." }, { "info": { "name": "Square Search Orders", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](entity:SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return resul" }, { "info": { "name": "Square Retrieve Order", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an [Order](entity:Order) by ID." }, { "info": { "name": "Square Update Order", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an open [order](entity:Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the u" }, { "info": { "name": "Square Pay Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/:order_id/pay", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order being paid." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment).\nAny " } ] }, { "info": { "name": "OrderCustomAttributes", "type": "folder" }, "items": [ { "info": { "name": "Square List Order Custom Attribute Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions", "params": [ { "name": "visibility_filter", "value": "", "type": "query", "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the order-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.\n\nWhen all response pages are retrieved, the results include all custom attribute definitions\nthat are visible to the requesting application, including those that are created by other\napplications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that\nseller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_REA" }, { "info": { "name": "Square Create Order Custom Attribute Definition", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an order-related custom attribute definition. Use this endpoint to\ndefine a custom attribute that can be associated with orders.\n\nAfter creating a custom attribute definition, you can set the custom attribute for orders\nin the Square seller account." }, { "info": { "name": "Square Retrieve Order Custom Attribute Definition", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to retrieve." }, { "name": "version", "value": "", "type": "query", "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nTo retrieve a custom attribute definition created by another application, the `visibility`\nsetting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Update Order Custom Attribute Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an order-related custom attribute definition for a Square seller account.\n\nOnly the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`." }, { "info": { "name": "Square Delete Order Custom Attribute Definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/orders/custom-attribute-definitions/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute definition to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an order-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.\n\nOnly the definition owner can delete a custom attribute definition." }, { "info": { "name": "Square Bulk Delete Order Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/custom-attributes/bulk-delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes order [custom attributes](entity:CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nThis `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 " }, { "info": { "name": "Square Bulk Upsert Order Custom Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/custom-attributes/bulk-upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates order [custom attributes](entity:CustomAttribute) as a bulk operation.\n\nUse this endpoint to delete one or more custom attributes from one or more orders.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nThis `BulkUpsertOrderCustomAttributes` endpoint accepts a map " }, { "info": { "name": "Square List Order Custom Attributes", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/:order_id/custom-attributes", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the target [order](entity:Order)." }, { "name": "visibility_filter", "value": "", "type": "query", "description": "Requests that all of the custom attributes be returned, or only those that are read-only or read-write." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor returned in the paged response from the previous call to this endpoint. \nProvide this cursor to retrieve the next page of results for your original request. \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single paged response. This limit is advisory. \nThe response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. \nThe default value is 20.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, { "name": "with_definitions", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each\ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the [custom attributes](entity:CustomAttribute) associated with an order.\n\nYou can use the `with_definitions` query parameter to also retrieve custom attribute definitions\nin the same call.\n\nWhen all response pages are retrieved, the results include all custom attributes that are\nvisible to the requesting application, including those that are owned by other applications\nand set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Retrieve Order Custom Attribute", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/:order_id/custom-attributes/:custom_attribute_key", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the target [order](entity:Order)." }, { "name": "custom_attribute_key", "value": "", "type": "path", "description": "The key of the custom attribute to retrieve. This key must match the key of an\nexisting custom attribute definition." }, { "name": "version", "value": "", "type": "query", "description": "To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol, include this optional field and specify the current version of the custom attribute." }, { "name": "with_definition", "value": "", "type": "query", "description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each \ncustom attribute. Set this parameter to `true` to get the name and description of each custom attribute, \ninformation about the data type, or other definition details. The default value is `false`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a [custom attribute](entity:CustomAttribute) associated with an order.\n\nYou can use the `with_definition` query parameter to also retrieve the custom attribute definition\nin the same call.\n\nTo retrieve a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\nalso known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." }, { "info": { "name": "Square Upsert Order Custom Attribute", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/:order_id/custom-attributes/:custom_attribute_key", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the target [order](entity:Order)." }, { "name": "custom_attribute_key", "value": "", "type": "path", "description": "The key of the custom attribute to create or update. This key must match the key \nof an existing custom attribute definition." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a [custom attribute](entity:CustomAttribute) for an order.\n\nUse this endpoint to set the value of a custom attribute for a specific order.\nA custom attribute is based on a custom attribute definition in a Square seller account. (To create a\ncustom attribute definition, use the [CreateOrderCustomAttributeDefinition](api-endpoint:OrderCustomAttributes-CreateOrderCustomAttributeDefinition) endpoint.)\n\nTo create or update a custom attribute owned by another application, the `visib" }, { "info": { "name": "Square Delete Order Custom Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/orders/:order_id/custom-attributes/:custom_attribute_key", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the target [order](entity:Order)." }, { "name": "custom_attribute_key", "value": "", "type": "path", "description": "The key of the custom attribute to delete. This key must match the key of an\nexisting custom attribute definition." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.\n\nTo delete a custom attribute owned by another application, the `visibility` setting must be\n`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes\n(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`." } ] }, { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Square List Payments", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/payments", "params": [ { "name": "begin_time", "value": "", "type": "query", "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. \nThe range is determined using the `created_at` field for each Payment.\nInclusive. Default: The current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The \nrange is determined using the `created_at` field for each Payment.\n\nDefault: The current time." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which results are listed by `ListPaymentsRequest.sort_field`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "location_id", "value": "", "type": "query", "description": "Limit results to the location supplied. By default, results are returned\nfor the default (main) location associated with the seller." }, { "name": "total", "value": "", "type": "query", "description": "The exact amount in the `total_money` for a payment." }, { "name": "last_4", "value": "", "type": "query", "description": "The last four digits of a payment card." }, { "name": "card_brand", "value": "", "type": "query", "description": "The brand of the payment card (for example, VISA)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\n\nThe default value of 100 is also the maximum allowed value. If the provided value is \ngreater than 100, it is ignored and the default value is used instead.\n\nDefault: `100`" }, { "name": "is_offline_payment", "value": "", "type": "query", "description": "Whether the payment was taken offline or not." }, { "name": "offline_begin_time", "value": "", "type": "query", "description": "Indicates the start of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time." }, { "name": "offline_end_time", "value": "", "type": "query", "description": "Indicates the end of the time range for which to retrieve offline payments, in RFC 3339\nformat for timestamps. The range is determined using the\n`offline_payment_details.client_created_at` field for each Payment. If set, payments without a\nvalue set in `offline_payment_details.client_created_at` will not be returned.\n\nDefault: The current time." }, { "name": "updated_at_begin_time", "value": "", "type": "query", "description": "Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment." }, { "name": "updated_at_end_time", "value": "", "type": "query", "description": "Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The\nrange is determined using the `updated_at` field for each Payment." }, { "name": "sort_field", "value": "", "type": "query", "description": "The field used to sort results by. The default is `CREATED_AT`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of payments taken by the account making the request.\n\nResults are eventually consistent, and new payments or changes to payments might take several\nseconds to appear.\n\nThe maximum results per page is 100." }, { "info": { "name": "Square Create Payment", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/payments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a payment using the provided source. You can use this endpoint \nto charge a card (credit/debit card or \nSquare gift card) or record a payment that the seller received outside of Square \n(cash payment from a buyer or a payment that an external entity \nprocessed on behalf of the seller).\n\nThe endpoint creates a \n`Payment` object and returns it in the response." }, { "info": { "name": "Square Cancel Payment by Idempotency Key", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/payments/cancel", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels (voids) a payment identified by the idempotency key that is specified in the\nrequest.\n\nUse this method when the status of a `CreatePayment` request is unknown (for example, after you send a\n`CreatePayment` request, a network error occurs and you do not get a response). In this case, you can\ndirect Square to cancel the payment using this endpoint. In the request, you provide the same\nidempotency key that you provided in your `CreatePayment` request that you want to cancel. After\ncanceling" }, { "info": { "name": "Square Get Payment", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/payments/:payment_id", "params": [ { "name": "payment_id", "value": "", "type": "path", "description": "A unique ID for the desired payment." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves details for a specific payment." }, { "info": { "name": "Square Update Payment", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/payments/:payment_id", "params": [ { "name": "payment_id", "value": "", "type": "path", "description": "The ID of the payment to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a payment with the APPROVED status.\nYou can update the `amount_money` and `tip_money` using this endpoint." }, { "info": { "name": "Square Cancel Payment", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/payments/:payment_id/cancel", "params": [ { "name": "payment_id", "value": "", "type": "path", "description": "The ID of the payment to cancel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels (voids) a payment. You can use this endpoint to cancel a payment with \nthe APPROVED `status`." }, { "info": { "name": "Square Complete Payment", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/payments/:payment_id/complete", "params": [ { "name": "payment_id", "value": "", "type": "path", "description": "The unique ID identifying the payment to be completed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Completes (captures) a payment.\nBy default, payments are set to complete immediately after they are created.\n\nYou can use this endpoint to complete a payment with the APPROVED `status`." } ] }, { "info": { "name": "Payouts", "type": "folder" }, "items": [ { "info": { "name": "Square List Payouts", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/payouts", "params": [ { "name": "location_id", "value": "", "type": "query", "description": "The ID of the location for which to list the payouts.\nBy default, payouts are returned for the default (main) location associated with the seller." }, { "name": "status", "value": "", "type": "query", "description": "If provided, only payouts with the given status are returned." }, { "name": "begin_time", "value": "", "type": "query", "description": "The timestamp for the beginning of the payout creation time, in RFC 3339 format.\nInclusive. Default: The current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "The timestamp for the end of the payout creation time, in RFC 3339 format.\nDefault: The current time." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which payouts are listed." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of all payouts for the default location.\nYou can filter payouts by location ID, status, time range, and order them in ascending or descending order.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope." }, { "info": { "name": "Square Get Payout", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/payouts/:payout_id", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "The ID of the payout to retrieve the information for." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves details of a specific payout identified by a payout ID.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope." }, { "info": { "name": "Square List Payout Entries", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/payouts/:payout_id/payout-entries", "params": [ { "name": "payout_id", "value": "", "type": "path", "description": "The ID of the payout to retrieve the information for." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which payout entries are listed." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\nIf request parameters change between requests, subsequent results may contain duplicates or missing records." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value. If the provided value is\ngreater than 100, it is ignored and the default value is used instead.\nDefault: `100`" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of all payout entries for a specific payout.\nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope." } ] }, { "info": { "name": "Refunds", "type": "folder" }, "items": [ { "info": { "name": "Square List Payment Refunds", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/refunds", "params": [ { "name": "begin_time", "value": "", "type": "query", "description": "Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`. \n\nDefault: The current time minus one year." }, { "name": "end_time", "value": "", "type": "query", "description": "Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339 \nformat. The range is determined using the `created_at` field for each `PaymentRefund`.\n\nDefault: The current time." }, { "name": "sort_order", "value": "", "type": "query", "description": "The order in which results are listed by `PaymentRefund.created_at`:\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default)." }, { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "location_id", "value": "", "type": "query", "description": "Limit results to the location supplied. By default, results are returned\nfor all locations associated with the seller." }, { "name": "status", "value": "", "type": "query", "description": "If provided, only refunds with the given status are returned.\nFor a list of refund status values, see [PaymentRefund](entity:PaymentRefund).\n\nDefault: If omitted, refunds are returned regardless of their status." }, { "name": "source_type", "value": "", "type": "query", "description": "If provided, only returns refunds whose payments have the indicated source type.\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.\nFor information about these payment source types, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).\n\nDefault: If omitted, refunds are returned regardless of the source type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to be returned in a single page.\n\nIt is possible to receive fewer results than the specified limit on a given page.\n\nIf the supplied value is greater than 100, no more than 100 results are returned.\n\nDefault: 100" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of refunds for the account making the request.\n\nResults are eventually consistent, and new refunds or changes to refunds might take several\nseconds to appear.\n\nThe maximum results per page is 100." }, { "info": { "name": "Square Refund Payment", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/refunds", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Refunds a payment. You can refund the entire payment amount or a\nportion of it. You can use this endpoint to refund a card payment or record a \nrefund of a cash or external payment. For more information, see\n[Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments)." }, { "info": { "name": "Square Get Payment Refund", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/refunds/:refund_id", "params": [ { "name": "refund_id", "value": "", "type": "path", "description": "The unique ID for the desired `PaymentRefund`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific refund using the `refund_id`." } ] }, { "info": { "name": "Sites", "type": "folder" }, "items": [ { "info": { "name": "Square List Sites", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/sites", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis)." } ] }, { "info": { "name": "Snippets", "type": "folder" }, "items": [ { "info": { "name": "Square Retrieve Snippet", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/sites/:site_id/snippet", "params": [ { "name": "site_id", "value": "", "type": "path", "description": "The ID of the site that contains the snippet." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/onlin" }, { "info": { "name": "Square Upsert Snippet", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/sites/:site_id/snippet", "params": [ { "name": "site_id", "value": "", "type": "path", "description": "The ID of the site where you want to add or update the snippet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds a snippet to a Square Online site or updates the existing snippet on the site. \nThe snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. \n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access prog" }, { "info": { "name": "Square Delete Snippet", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/sites/:site_id/snippet", "params": [ { "name": "site_id", "value": "", "type": "path", "description": "The ID of the site that contains the snippet." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes your snippet from a Square Online site.\n\nYou can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.\n\n\n__Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis)." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Square Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enrolls a customer in a subscription.\n\nIf you provide a card on file in the request, Square charges the card for\nthe subscription. Otherwise, Square sends an invoice to the customer's email\naddress. The subscription starts immediately, unless the request includes\nthe optional `start_date`. Each individual subscription is associated with a particular location.\n\nFor more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-sub" }, { "info": { "name": "Square Bulk Swap Plan", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/bulk-swap-plan", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedules a plan variation change for all active subscriptions under a given plan\nvariation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations)." }, { "info": { "name": "Square Search Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for subscriptions.\n\nResults are ordered chronologically by subscription creation date. If\nthe request specifies more than one location ID,\nthe endpoint orders the result\nby location ID, and then by creation date within each location. If no locations are given\nin the query, all locations are searched.\n\nYou can also optionally specify `customer_ids` to search by customer.\nIf left unset, all customers\nassociated with the specified locations are returned.\nIf the request specifies customer I" }, { "info": { "name": "Square Retrieve Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to retrieve." }, { "name": "include", "value": "", "type": "query", "description": "A query parameter to specify related information to be included in the response. \n\nThe supported query parameter values are: \n\n- `actions`: to include scheduled actions on the targeted subscription." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific subscription." }, { "info": { "name": "Square Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a subscription by modifying or clearing `subscription` field values.\nTo clear a field, set its value to `null`." }, { "info": { "name": "Square Delete Subscription Action", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/actions/:action_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription the targeted action is to act upon." }, { "name": "action_id", "value": "", "type": "path", "description": "The ID of the targeted action to be deleted." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a scheduled action for a subscription." }, { "info": { "name": "Square Change Billing Anchor Date", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/billing-anchor", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to update the billing anchor date." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates)\nfor a subscription." }, { "info": { "name": "Square Cancel Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/cancel", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to cancel." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedules a `CANCEL` action to cancel an active subscription. This \nsets the `canceled_date` field to the end of the active billing period. After this date, \nthe subscription status changes from ACTIVE to CANCELED." }, { "info": { "name": "Square List Subscription Events", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/events", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to retrieve the events for." }, { "name": "cursor", "value": "", "type": "query", "description": "When the total number of resulting subscription events exceeds the limit of a paged response, \nspecify the cursor returned from a preceding response here to fetch the next set of results.\nIf the cursor is unset, the response contains the last page of the results.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The upper limit on the number of subscription events to return\nin a paged response." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription." }, { "info": { "name": "Square Pause Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/pause", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to pause." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedules a `PAUSE` action to pause an active subscription." }, { "info": { "name": "Square Resume Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/resume", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to resume." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedules a `RESUME` action to resume a paused or a deactivated subscription." }, { "info": { "name": "Square Swap Plan", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/subscriptions/:subscription_id/swap-plan", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The ID of the subscription to swap the subscription plan for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. \nFor more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations)." } ] }, { "info": { "name": "Team", "type": "folder" }, "items": [ { "info": { "name": "Square Create Team Member", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/team-members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates.\nYou must provide the following values in your request to this endpoint:\n- `given_name`\n- `family_name`\n\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember)." }, { "info": { "name": "Square Bulk Create Team Members", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/team-members/bulk-create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates.\nThis process is non-transactional and processes as much of the request as possible. If one of the creates in\nthe request cannot be successfully processed, the request is not marked as failed, but the body of the response\ncontains explicit error information for the failed create.\n\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create" }, { "info": { "name": "Square Bulk Update Team Members", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/team-members/bulk-update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates.\nThis process is non-transactional and processes as much of the request as possible. If one of the updates in\nthe request cannot be successfully processed, the request is not marked as failed, but the body of the response\ncontains explicit error information for the failed update.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-" }, { "info": { "name": "Square List Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/team-members/jobs", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor returned by the previous call to this endpoint. Provide this\ncursor to retrieve the next page of results for your original request. For more information,\nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists jobs in a seller account. Results are sorted by title in ascending order." }, { "info": { "name": "Square Create Job", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/team-members/jobs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a job in a seller account. A job defines a title and tip eligibility. Note that\ncompensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting." }, { "info": { "name": "Square Retrieve Job", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/team-members/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path", "description": "The ID of the job to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specified job." }, { "info": { "name": "Square Update Job", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/team-members/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path", "description": "The ID of the job to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the title or tip eligibility of a job. Changes to the title propagate to all\n`JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to\ntip eligibility propagate to all `TeamMemberWage` objects that reference the job ID." }, { "info": { "name": "Square Search Team Members", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/team-members/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of `TeamMember` objects for a business. \nThe list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether\nthe team member is the Square account owner." }, { "info": { "name": "Square Retrieve Team Member", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/team-members/:team_member_id", "params": [ { "name": "team_member_id", "value": "", "type": "path", "description": "The ID of the team member to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a `TeamMember` object for the given `TeamMember.id`.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member)." }, { "info": { "name": "Square Update Team Member", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/team-members/:team_member_id", "params": [ { "name": "team_member_id", "value": "", "type": "path", "description": "The ID of the team member to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.\nLearn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member)." }, { "info": { "name": "Square Retrieve Wage Setting", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/team-members/:team_member_id/wage-setting", "params": [ { "name": "team_member_id", "value": "", "type": "path", "description": "The ID of the team member for which to retrieve the wage setting." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a `WageSetting` object for a team member specified\nby `TeamMember.id`. For more information, see\n[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).\n\nSquare recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers)\nto get this information directly from the `TeamMember.wage_setting` field." }, { "info": { "name": "Square Update Wage Setting", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/team-members/:team_member_id/wage-setting", "params": [ { "name": "team_member_id", "value": "", "type": "path", "description": "The ID of the team member for which to update the `WageSetting` object." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates or updates a `WageSetting` object. The object is created if a\n`WageSetting` with the specified `team_member_id` doesn't exist. Otherwise,\nit fully replaces the `WageSetting` object for the team member.\nThe `WageSetting` is returned on a successful update. For more information, see\n[Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).\n\nSquare recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [Upda" } ] }, { "info": { "name": "Terminal", "type": "folder" }, "items": [ { "info": { "name": "Square Create Terminal Action", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/actions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Terminal action request and sends it to the specified device." }, { "info": { "name": "Square Search Terminal Actions", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/actions/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days." }, { "info": { "name": "Square Get Terminal Action", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/terminals/actions/:action_id", "params": [ { "name": "action_id", "value": "", "type": "path", "description": "Unique ID for the desired `TerminalAction`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days." }, { "info": { "name": "Square Cancel Terminal Action", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/actions/:action_id/cancel", "params": [ { "name": "action_id", "value": "", "type": "path", "description": "Unique ID for the desired `TerminalAction`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels a Terminal action request if the status of the request permits it." }, { "info": { "name": "Square Dismiss Terminal Action", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/actions/:action_id/dismiss", "params": [ { "name": "action_id", "value": "", "type": "path", "description": "Unique ID for the `TerminalAction` associated with the action to be dismissed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Dismisses a Terminal action request if the status and type of the request permits it.\n\nSee [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details." }, { "info": { "name": "Square Create Terminal Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/checkouts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Terminal checkout request and sends it to the specified device to take a payment\nfor the requested amount." }, { "info": { "name": "Square Search Terminal Checkouts", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/checkouts/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days." }, { "info": { "name": "Square Get Terminal Checkout", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id", "params": [ { "name": "checkout_id", "value": "", "type": "path", "description": "The unique ID for the desired `TerminalCheckout`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days." }, { "info": { "name": "Square Cancel Terminal Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id/cancel", "params": [ { "name": "checkout_id", "value": "", "type": "path", "description": "The unique ID for the desired `TerminalCheckout`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels a Terminal checkout request if the status of the request permits it." }, { "info": { "name": "Square Dismiss Terminal Checkout", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/checkouts/:checkout_id/dismiss", "params": [ { "name": "checkout_id", "value": "", "type": "path", "description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Dismisses a Terminal checkout request if the status and type of the request permits it." }, { "info": { "name": "Square Create Terminal Refund", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/refunds", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](api:Refunds)." }, { "info": { "name": "Square Search Terminal Refunds", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/refunds/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days." }, { "info": { "name": "Square Get Terminal Refund", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id", "params": [ { "name": "terminal_refund_id", "value": "", "type": "path", "description": "The unique ID for the desired `TerminalRefund`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days." }, { "info": { "name": "Square Cancel Terminal Refund", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id/cancel", "params": [ { "name": "terminal_refund_id", "value": "", "type": "path", "description": "The unique ID for the desired `TerminalRefund`." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it." }, { "info": { "name": "Square Dismiss Terminal Refund", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/terminals/refunds/:terminal_refund_id/dismiss", "params": [ { "name": "terminal_refund_id", "value": "", "type": "path", "description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Dismisses a Terminal refund request if the status and type of the request permits it." } ] }, { "info": { "name": "Vendors", "type": "folder" }, "items": [ { "info": { "name": "Square Bulk Create Vendors", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/vendors/bulk-create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller." }, { "info": { "name": "Square Bulk Retrieve Vendors", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/vendors/bulk-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs." }, { "info": { "name": "Square Bulk Update Vendors", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/vendors/bulk-update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller." }, { "info": { "name": "Square Create Vendor", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/vendors/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller." }, { "info": { "name": "Square Search Vendors", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/vendors/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter." }, { "info": { "name": "Square Retrieve Vendor", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/vendors/:vendor_id", "params": [ { "name": "vendor_id", "value": "", "type": "path", "description": "ID of the [Vendor](entity:Vendor) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the vendor of a specified [Vendor](entity:Vendor) ID." }, { "info": { "name": "Square Update Vendor", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/vendors/:vendor_id", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller." } ] }, { "info": { "name": "WebhookSubscriptions", "type": "folder" }, "items": [ { "info": { "name": "Square List Webhook Event Types", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/webhooks/event-types", "params": [ { "name": "api_version", "value": "", "type": "query", "description": "The API version for which to list event types. Setting this field overrides the default version used by the application." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all webhook event types that can be subscribed to." }, { "info": { "name": "Square List Webhook Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/webhooks/subscriptions", "params": [ { "name": "cursor", "value": "", "type": "query", "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\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "include_disabled", "value": "", "type": "query", "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned." }, { "name": "sort_order", "value": "", "type": "query", "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all webhook subscriptions owned by your application." }, { "info": { "name": "Square Create Webhook Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/webhooks/subscriptions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a webhook subscription." }, { "info": { "name": "Square Retrieve Webhook Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a webhook subscription identified by its ID." }, { "info": { "name": "Square Update Webhook Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a webhook subscription." }, { "info": { "name": "Square Delete Webhook Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a webhook subscription." }, { "info": { "name": "Square Update Webhook Subscription Signature Key", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id/signature-key", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a webhook subscription by replacing the existing signature key with a new one." }, { "info": { "name": "Square Test Webhook Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id/test", "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Tests a webhook subscription by sending a test event to the notification URL." } ] } ], "bundled": true }