Delete a job

DELETE/v2/api/store/{team_slug}/v2/job/{hash_id}

v2Operation ID v2_public_job_destroy

Check success, not only the HTTP status: when the job's order is neither a draft nor published, this call deletes the job anyway and then answers HTTP 200 with { "status": 500, "success": false, "error": { "code": "action_not_allowed", "message": null } }.

Deletes a job and every line item on it.

Deleting a job also removes those lines from the order's shipments and invoices, releases the stock allocated to them, removes their needs-ordering entries, and recalculates the order's totals. It can't be undone.

On an order that came from Shopify the lines are not deleted: they stay on the order without a job.

Permission

Needs permission to edit the job's sales order:

• the team owner;
• a role whose Manage Sales Orders permission is "update all";
• a role with "update assigned" when you created the order or are assigned to it; or
• on a draft order, its creator when their role can create sales orders.

Otherwise 403 user_is_not_authorized.

Side effects

• Deletes the job's line items (Shopify orders: detaches them instead).
• Deletes the matching shipment and invoice line items, so shipment and invoice totals change (not on Shopify orders).
• Releases allocated stock and removes the needs-ordering entries of the deleted lines (not on Shopify orders).
• Recalculates the sales order totals (not on Shopify orders). Open Admin Portal pages refresh, and on a published order so do Customer Portal pages the customer has open.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The job's hash id (id). Hash ids only: a unique key or a document number gives 404.

  • Example WaGvtaWsx7Kcn4

Request body

This operation takes no request body.

Response

200Successful response.

A 200 answer can still be a refusal

Check success (and the fields named below) as well as the HTTP status:

• The order is in a state this call refuses: success: false, error.code action_not_allowed. Fix: Check success in every reply. Publish the order (or work on a draft) first.

Refused with HTTP 200: `success` is false

{
  "error": {
    "code": "action_not_allowed",
    "message": null
  },
  "status": 500,
  "success": false
}

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 edit this order (user_is_not_authorized).

  Fix

  Ask the team owner to give your role Manage Sales Orders, or assign you to the order.

• 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 job isn't on one of your team's sales orders.

  Fix

  Check the job 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.

Notes

• A refusal here is HTTP 200 with success: false and error.code action_not_allowed (the body's status says 500). A client that only checks the HTTP status will treat it as done.
• Lines are removed from invoices even when the invoice has payments. Check the order's invoices before you delete a job.

Related

• GETGet one job of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/{job_id}
• PUTCopy a job/v2/api/store/{team_slug}/v2/job/{hash_id}/clone
• GETGet an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}

Example request

curl

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