Delete a customer

DELETE/v1/api/store/{team_slug}/customer/{hash_id}

v1Operation ID v1_public_customer_destroy

Deletes a customer. The customer can be restored later; its sales orders, quotes, invoices and payments stay as they are.

Refused with 422 delete_fail while the customer has an open quote or sales order: any saved quote or sales order whose status is not a final (end) status. Finish, cancel or delete those first, or archive the customer instead (hide: true).

Permission

Needs the Manage Customers permission: "Manage All" for any customer, or "Manage Assigned to User" for customers assigned to you.

Business rules

• Customers synced from Shopify are read-only here: changes are refused with 422 validation_error "External customers are read-only. Manage changes from Shopify." System customers (is_system: true) are refused the same way ("System customer cannot be modified or deleted.").

Side effects

• Sends the customer.deleted webhook.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The customer's id (id from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• 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 can't change this customer: it has no Manage Customers permission, or it manages only customers assigned to you and this one is not. This 403 has a short body, {"message": "No Permission to update Customer"}.

  Fix

  Ask for Manage Customers "Manage All", or to be assigned to the customer.

• 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 live customer with this id in the team: deleted customers are not found here. error.code is null and error.message names the record type.

  Fix

  Check the id. Find deleted customers with the trashed_only filter and restore them first.

• 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

  The customer has an open quote or sales order (error.code delete_fail, error.message "This customer can't be removed while it has an open quote or sales order.").

  Fix

  Move those orders to a final status or delete them, or archive the customer with hide: true.

  When

  The customer comes from Shopify, or is a system customer (error.code validation_error, with the reason in error.message).

  Fix

  Change Shopify customers in Shopify. System customers cannot be changed.

Notes

• Deleted customers are hidden from lists. Find them with the trashed_only filter and bring them back with Restore a customer.

Related

• PATCHRestore a deleted customer/v1/api/store/{team_slug}/customer/{hash_id}/restore
• PATCHUpdate a customer (PATCH)/v1/api/store/{team_slug}/customer/{hash_id}

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed' \  -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
}