Delete a company location

DELETE/v1/api/store/{team_slug}/setting/location/{hash_id}

v1Operation ID v1_public_location_destroy

Deletes a company location. Orders and documents that used it keep showing it; it can be restored.

When you delete the team's last warehouse, YoPrint turns the primary location into a warehouse so the team still has one.

Permission

Needs the Manage Settings permission.

Business rules

• The primary location cannot be deleted.
• Replaced versions and external addresses cannot be deleted.

Side effects

• Deleting the last warehouse makes the primary location a warehouse.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The company location's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example 5ySODwONuta7hu

Request body

This operation takes no request body.

Response

200Successful response.

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

  When

  No company location with that id on this team (error.code is null and error.message starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both page_not_found).

  Fix

  Use an id from the list operation and check the team slug.

• 409Not deleted: the id is a replaced, external or redacted row, or it is the last warehouse and no current primary location can take over.

  When

  It is the last warehouse and there is no current primary location to take over (error.code hold_stock_repair_failed).

  Fix

  Make another location a warehouse first.

  When

  It is a replaced version, or an external or redacted address. The body is the one Update a company location gives on a 409, {success: false, address_save_result, message}, with save_mode blocked_superseded_historical_address or blocked_external_or_compliance.

  Fix

  Use the current location instead.

• 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

  It is the primary location (primary_delete_err).

  Fix

  Make another location primary first.

Notes

• YoPrint doesn't move the default warehouse when you delete it. Set another default warehouse afterwards.

Related

• PATCHRestore a company location/v1/api/store/{team_slug}/setting/location/{id}/restore
• PATCHSet the primary location/v1/api/store/{team_slug}/setting/location/{id}/primary

Example request

curl

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

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}