Get one product

Fetch a single product by id, when you already know which one you want.

get /api/public/v1/products/{id}

Headers

Header	Value	Why
X-AUTH-TOKEN	obl_live_...	Your API key. Every call needs one.

Parameters

Name	In	What it does
id required	path	Product identifier

The call

Request

curl https://app.obraledger.com/api/public/v1/products/... \
  -H "X-AUTH-TOKEN: obl_live_..."

Want to fill this in and run it? Open it in the playground.

What comes back

One product.

Shape of the response

Generated from the contract, so it is every field and nothing invented. The values are type names rather than a specimen record - we won't put made-up data on a page.

{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "name": "string",
  "description": "string",
  "productNumber": "string",
  "articleCode": "string",
  "ean": "string",
  "upcCode": "string",
  "hsnCode": "string",
  "brand": "string",
  "model": "string",
  "type": "string",
  "version": "string",
  "remark": "string",
  "infoUrl": "string",
  "serialNumber": "string",
  "labels": "string",
  "tags": [],
  "categoryId": "string",
  "unitId": "string",
  "status": "string",
  "isInactive": false,
  "isSaleItem": false,
  "isPurchaseItem": false,
  "isStockItem": false,
  "isCatalogItem": false,
  "isWebShop": false,
  "isFeaturedProduct": false,
  "stockProductType": "string",
  "validFrom": "string",
  "validTo": "string",
  "salePrice": "decimal string",
  "saleRrpPrice": "decimal string",
  "salePriceIncludesTax": false,
  "salePriceDecimals": 0,
  "saleTaxCode": "string",
  "saleTaxStatus": "string",
  "isSaleIndividual": false,
  "isShippingRequired": false,
  "isShippingTaxable": false,
  "saleLedgerAccountCode": "string",
  "purchaseLedgerAccountCode": "string",
  "stockLedgerAccountCode": "string",
  "cogsLedgerAccountCode": "string",
  "stockQuantity": 0,
  "stockMinimalQuantity": 0,
  "stockLocation": "string",
  "quantityDefault": 0,
  "quantityBackorder": 0,
  "stockDescription": "string",
  "stockDocumentTypes": [],
  "color": "string",
  "diameter": "string",
  "depth": "string",
  "height": "string",
  "length": "string",
  "opening": "string",
  "width": "string",
  "volume": "string",
  "weight": "string"
}

When it fails

Match on the type in the body, not on the status. A 403 covers both "this key can't do that" and "this record won't allow it", and the number alone can't tell you which.

401 Authentication failed — the `X-AUTH-TOKEN` header is missing, malformed, revoked, or belongs to a different company. Not retryable: the same token will fail identically.

unauthenticated
403 Authenticated, but not allowed to do this.

forbidden scope_required
404 No such record, for the company this key is bound to.

not_found
429 Rate limit exceeded for this API key. `Retry-After` says how many seconds to wait; `X-RateLimit-Limit` and `X-RateLimit-Remaining` report the budget on every response, not just this one.

rate_limited

The rest of products

Base URL https://app.obraledger.com. This page is generated from the contract the product publishes.

Building something and stuck? Tell us - we'd rather hear it than have you guess.