List service locations

GET/v1/api/store/{team_slug}/service_location

v1Operation ID v1_public_service_location_index

Lists every service location of the team, deleted ones included (trashed: true), each with id, name, enable and the services (id, name) offered there. Not paged.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (5)

  • enablebooleanrequired
  • idstringrequired
  • namestring | nullrequired
  • servicesarray of objectsrequired

    The services offered at this location.

    Fields of each item (2)

    • idstringrequired
    • namestring | nullrequired
  • trashedbooleanrequired
• statusintegerrequired
• successbooleanrequired

Errors

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

• 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.

• 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.

Related

• POSTCreate a service location/v1/api/store/{team_slug}/service_location

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/service_location' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "enable": true,
      "id": "454DGJ3i6EQpq0",
      "name": "Shirt - Left Chest",
      "services": [
        {
          "id": "IIVE3hadAUOmIA",
          "name": "Screen printing"
        }
      ],
      "trashed": false
    }
  ],
  "status": 200,
  "success": true
}