Delete a shipping estimate

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

v2Operation ID v2_public_shipment_estimate_destroy

Deletes a saved shipping estimate. Nothing is sent to Shippo, and shipment lines that bill for the estimate are left as they are.

Permission

Any member of the team. No sales order permission is checked.

Side effects

• Open Admin Portal pages refresh.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The shipping estimate's hash id. Hash ids only: a unique key or a document number gives 404.

  • Example tVjoZLKlSwZFF5

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.

• 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 estimate isn't your team's, or is already deleted.

  Fix

  Treat a 404 on a repeat delete as done.

Related

• GETList the shipping estimates of a shipment/v2/api/store/{team_slug}/v2/shipment/{hash_id}/estimates

Example request

curl

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