Skip to Content

List the products

GET
/v1/ec/products

What your key's business sells in its environment: the catalog a sale picks from, newest first. Unlike GET /v1/ec/items, which reads the lines of documents already issued, a product is kept on purpose, with its price, its barcode and its photo.

Authorization

headerAuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.

Query Parameters

limit?integer

How many per page, from 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.

Lengthlength <= 200
q?string

Words of the description (ignoring case and accents), or the start of a barcode. Every word must match.

Length1 <= length <= 100
category_id?string

Only the products of this category.

Formatuuid
favorite?string

true: only the favourites. false: only those that aren't.

Value in"true""false"
archived?string

true: only the archived products. Without it, or false, only those for sale.

Value in"true""false"

Header Parameters

Fiscalbase-Environment?string

The environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.

Formatuuid
Fiscalbase-Channel?string

Which of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.

Value in"api""mcp"
Fiscalbase-Agent?string

The AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.

Response Body

A page of products

application/json
  1. response
object*"list"
Value in"list"
data*array<>
next_cursor*|

The next page (older); null if there are no more.

prev_cursor*|

The previous page (newer); null on the first.

Example Request
curl -X GET 'https://api.fiscalbase.io/v1/ec/products'
Example Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object": "product",
      "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
      "environment": "sandbox",
      "description": "string",
      "price_with_iva": "string",
      "unit_price": "string",
      "sold_by": "unit",
      "barcode": "string",
      "code": "string",
      "auxiliary_code": "string",
      "unit": "string",
      "taxes": [
        {
          "type": "iva",
          "rate": "iva_15"
        }
      ],
      "additional_info": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
      "favorite": true,
      "position": 0,
      "image": {
        "url": "http://example.com",
        "width": 0,
        "height": 0
      },
      "archived_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}