Skip to Content
HelvetlyDocs
API referenceProducts

Archive a product

Needs a token with the write:products scope. Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

POST
/api/v1/products/{id}/archive

Hides the item from pickers and the default list while keeping it for reference; unarchive_product reverses it. Owner or admin only. Archiving an archived item is not an error, so a retry is safe. Returns the item.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Path Parameters

id*string

The item's id.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://app.helvetly.com/api/v1/products/string/archive'
Example Response
{  "data": {    "id": "string",    "type": "product",    "name": "string",    "description": "string",    "sku": "string",    "gtin": "string",    "unit": "string",    "price_basis": "string",    "unit_price": "1234.50",    "unit_price_net": "1234.50",    "unit_price_gross": "1234.50",    "currency": "string",    "vat_category": "string",    "vat_rate": "string",    "is_archived": true,    "archived_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}