Tikra Docs
Volver al sistema
Tikra DocsVolver al sistema
Documentación de Tikra
API del PortalQuick StartAutenticaciónErroresIdempotency, paginación y rate limitsRecetasWebhooksReferencia OpenAPI
API del Portal

Referencia OpenAPI

Documentación interactiva de todos los endpoints de la Tikra Portal API.

Esta página renderea cada operación con su request/response schema y un playground interactivo (button Send) para probar en vivo.

Saltá a la sección que te interesa:

Salud y cuenta

Stock e inventario

Remitos

Pedidos

Cuenta corriente

Destinatarios

Webhooks

Salud y cuenta

GET /health no requiere auth — útil para uptime monitors. GET /me devuelve la identidad de la API key activa + sus rate limits actuales.

GET
/health

Response Body

application/json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/health"
{
  "ok": true,
  "version": "string"
}
GET
/me

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/me"
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}

Stock e inventario

Consulta de stock distribuido en tu warehouse + lots con vencimiento + historial de movimientos.

GET
/stock

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
cursor?string
product_id?string
search?string
min_qty?number

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock"
{
  "data": [
    {}
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
GET
/stock/{product_id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

product_id*string

Response Body

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
GET
/stock/lots

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

product_id?string
expires_before?string
Formatdate-time

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock/lots"
Empty
GET
/movements

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

type?string
Value in"ingreso" | "egreso" | "ajuste" | "void"
product_id?string
from?string
Formatdate-time
to?string
Formatdate-time

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/movements"
Empty

Remitos

Listado y detalle de remitos de ingreso/egreso de tu stock. Cada remito incluye sus items.

GET
/remitos

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/remitos"
Empty
GET
/remitos/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/remitos/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}

Pedidos

Crear pedidos vía API (idempotent), consultar status, cancelar y subir attachments PDF (preimpresos).

GET
/orders

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/orders"
Empty
POST
/orders

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string
Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/orders" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "destinatario_id": "4a973a49-fb63-494f-92e3-d213b261bff9",    "items": [      {        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",        "quantity": 0      }    ]  }'
Empty
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
Empty
GET
/orders/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/orders/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
PATCH
/orders/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/orders/string" \  -H "Content-Type: application/json" \  -d '{    "action": "cancel"  }'
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
Empty
POST
/orders/{id}/attachments

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/orders/string/attachments" \  -F file="string"
Empty
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
Empty

Cuenta corriente

Saldo actual y movimientos de cuenta (pagos, facturas, notas de crédito).

GET
/balance

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/balance"
Empty
GET
/transactions

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/transactions"
Empty

Destinatarios

CRUD de destinatarios (lugares donde despacha tu stock).

GET
/destinatarios

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios"
Empty
POST
/destinatarios

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
Empty
Empty
PATCH
/destinatarios/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
DELETE
/destinatarios/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/problem+json

curl -X DELETE "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}

Webhooks

Suscribirte a 12 events firmados con HMAC-SHA256. Manejo completo: registrar endpoints, rotar secrets, ver historial de deliveries, retry manual.

GET
/webhooks

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks"
Empty
POST
/webhooks

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "events": [      "string"    ]  }'
Empty
Empty
Empty
GET
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
PATCH
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
DELETE
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/problem+json

curl -X DELETE "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "string"
}
POST
/webhooks/{id}/rotate-secret

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string/rotate-secret"
Empty
GET
/webhooks/{id}/deliveries

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

status?string
Value in"pending" | "succeeded" | "failed" | "abandoned"
event_type?string

Response Body

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string/deliveries"
Empty
POST
/webhooks/{id}/deliveries/{delivery_id}/retry

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
delivery_id*string

Response Body

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/string/deliveries/string/retry"
Empty
Empty

Webhooks

Eventos, formato de payload y verificación HMAC-SHA256 para webhooks de Tikra.

On this page

Salud y cuentaStock e inventarioRemitosPedidosCuenta corrienteDestinatariosWebhooks
destinatario_id*string
Formatuuid
items*array<>
Items1 <= items
notes?string
delivery_type?string
Value in"domicilio" | "retiro"
delivery_address?string
delivery_city?string
delivery_province?string
delivery_contact?string
action*string
Value in"cancel"
reason?string
file*file
Formatbinary
name*string
Lengthlength <= 120
address?string|null
city?string|null
province?string|null
postal_code?string|null
phone?string|null
email?|
Formatemail
cuit_dni?string|null
iva_condition?string|null
delivery_schedule?string|null
url*string
Formaturi
description?string
events*array<string>
Items1 <= items