Create a service location

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

v1Operation ID v1_public_service_location_store

Creates a service location and returns it. Link it to services in YoPrint (Settings).

Permission

Needs the Manage Services permission at the level that can create services.

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.

• namestringrequired

  Where on the item the decoration goes, such as "Shirt - Front". Need not be unique.

• enableboolean

  Whether it can be picked. Defaults to true. Not checked: send a JSON boolean.

Response

200Successful response.

• dataobjectrequired
  Child fields (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.

  When

  Your role cannot create services. This 403 has a short body, {"message": "Insufficient Permission"}, with no success or error.

  Fix

  Ask a team owner to set Manage Services to the level that can create.

• 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

  name is missing. error.code is validation_failed.

  Fix

  Send a name.

Notes

• Leave enable out and the location is saved enabled, but this answer shows enable: false (it is not read back). Send enable: true, or read the location again.

Related

• GETList service locations/v1/api/store/{team_slug}/service_location

Example request

curl

curl -X POST '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' \  -H 'Content-Type: application/json' \  -d '{    "enable": true,    "name": "Shirt - Left Chest"  }'

Example response 200

Response

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