Delete an order approval

DELETE/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}

v2Operation ID v2_public_order_approval_destroy

Deletes an order approval that is not completed yet. A completed approval can't be deleted: the call fails. {hash_id2} is the approval's id. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Business rules

• Only approvals that are not completed. Shopify orders refuse approval changes.
• An old (version 1) order answers 404 here, as an unknown order does.

Side effects

• Customer Portal pages the order's customer has open refresh (a live update, not an email).

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7
• hash_id2stringrequired

  The approval's id (a hash id).

  • Example xTKi8BqFVVmlL6

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired

  No data.

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

  When

  The order or approval isn't found, or the order is an old (version 1) order.

  Fix

  Use a current sales order's or quote's 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

  A Shopify order: "Shopify orders do not support approval workflows in YoPrint."

  Fix

  Shopify orders have no approvals.

• 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

  The approval is completed (an error with no code).

  Fix

  Leave completed approvals in place.

Related

• POSTAsk the customer to approve an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/approval/xTKi8BqFVVmlL6' \  -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
}