v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar itens

get/items

Query parameters

showinteger

Número de itens na página de resultado

cursorstring

Hash da próxima página.

category_idinteger

ID da categoria ou subcategoria do item

namestring

Nome do item

descriptionstring

Descrição do item

minimum_valuenumber float

Valor unitário do item

referencestring

Referência do item

typeinteger

Tipo de item (0= produto / 1= recorrência (MRR) / 2= serviço)

statusboolean

Status do item (False= item ativo / True= item inativo)

brand_idstring

ID da marca à qual o item está vinculado

codestring

Código do item

created_at_startstring date-time

Filtrar por itens criados a partir da data e hora informada.

created_at_endstring date-time

Filtrar por itens criados até a data e hora informada.

updated_at_startstring date-time

filtar itens por data de atualização a partir da data e hora informada.

updated_at_endstring date-time

filtar itens por data de atualização até da data e hora informada.

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "category_id": 748,
      "name": "Pepsi",
      "description": "é uma bebida não alcoólica e não fermentada, fabricada industrialmente, à base de água mineral e açúcar, podendo conter edulcorante, extratos ou aroma sintetizado de frutas ou outros vegetais e gás carbônico.",
      "minimum_value": 5.25,
      "cost": 2,
      "reference": "#1234",
      "photo": "https://example.org/photo.png",
      "commission": 10.5,
      "brand_id": 1,
      "ipi_tax": 2,
      "code": "9",
      "fix_comission_value": 11.5,
      "measurement_unit_id": 748,
      "created_at": "2015-10-05 00:00:00",
      "updated_at": "2015-10-05 00:00:00"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6MTY0N....JdGVtcyI6dHJ1ZX0"
    }
  }
}