Get a product (GET /api/v1/products/{id})

Needs a token with the read:products scope (or write:products). 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.

GET

/api/v1/products/{id}

GET

/api/v1/products/{id}

One catalogue item, archived ones included.

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

application/json

response

data*

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/products/string'

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/products/string'

Example ResponseSchema

{
  "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"
  }
}

{  "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"  }}

Get a product

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body