List Square locations

PUT/v1/api/store/{team_slug}/setting/payment_gateway/get_square_location_list

v1Operation ID v1_public_setting_payment_gateway_square_location_list

Asks Square for the locations a Square access token can see, and returns each one's id, name and status. Use the ids for square_location_id and square_webhook_locations in Update payment gateway settings.

Nothing is saved. The token is used for this one call.

Permission

Needs the Manage Settings permission. It uses PUT although it only reads.

Side effects

• Calls Square's Locations API.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• square_access_tokenstringrequired

  A Square access token.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (3)

  • idstringrequired

    The Square location id.

  • namestringrequired
  • statusstringrequired

    Square's location status, such as ACTIVE.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  square_access_token is missing. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  Square refused the token (for example a wrong or expired one) or couldn't be reached. YoPrint answers with a generic server error, {"message": "Server Error"}, that doesn't say which.

  Fix

  Check the access token in the Square Developer Dashboard, then try again.

Related

• PUTUpdate payment gateway settings/v1/api/store/{team_slug}/setting/payment_gateway

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_gateway/get_square_location_list' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "square_access_token": "YOUR_GATEWAY_SECRET"  }'

Example response 200

Response

{
  "data": [
    {
      "id": "L8EXAMPLE01",
      "name": "Main shop",
      "status": "ACTIVE"
    }
  ],
  "status": 200,
  "success": true
}