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": "v1"
}
GET
/me

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/me"
{
  "client": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "cuit_dni": "string",
    "email": "string"
  },
  "key": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "key_prefix": "tk_live_",
    "scopes": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "last_used_at": "2019-08-24T14:15:22Z"
  },
  "rate_limits": {
    "read_per_hour": 1000,
    "write_per_hour": 100,
    "burst_per_minute": 100
  }
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Stock e inventario

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

GET
/stock

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

product_id?string
Formatuuid
min_qty?number

Cantidad mínima (gte). Default 0.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock"
{
  "data": [
    {
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "products": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "sku": "string",
        "unit_type": "string"
      },
      "quantity": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/stock/{product_id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

product_id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  "products": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "sku": "string",
    "unit_type": "string"
  },
  "quantity": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/stock/lots

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

product_id?string
Formatuuid
expires_before?string

Solo lotes con expiry_date <= valor (lte).

Formatdate

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/stock/lots"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "lot_number": "string",
      "quantity": 0,
      "expiry_date": "2019-08-24",
      "products": {
        "name": "string",
        "sku": "string"
      }
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Remitos

Listado y detalle de remitos de ingreso/egreso de tu stock. Cada remito incluye sus items. GET /movements da un historial liviano de esos remitos como movimientos de cuenta (ingreso/egreso) — requiere el scope read:activity.

GET
/remitos

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

type?string
Value in"ingreso" | "egreso"
status?string
from?string
Formatdate-time
to?string
Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/remitos"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "ingreso",
      "status": "string",
      "date": "string",
      "remito_number": [
        "string"
      ],
      "source_order_id": "ea4c148f-afbc-43e2-bd2c-742a123a815e",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/remitos/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/remitos/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "ingreso",
  "status": "string",
  "date": "string",
  "remito_number": [
    "string"
  ],
  "source_order_id": "ea4c148f-afbc-43e2-bd2c-742a123a815e",
  "created_at": "2019-08-24T14:15:22Z",
  "distribution_remito_items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "quantity": 0,
      "expiry_date": "2019-08-24",
      "vintage_year": 0,
      "notes": "string",
      "products": {
        "name": "string",
        "sku": "string"
      }
    }
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/movements

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

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

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/movements"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "ingreso",
      "status": "string",
      "date": "string",
      "remito_number": [
        "string"
      ],
      "source_order_id": "ea4c148f-afbc-43e2-bd2c-742a123a815e",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Pedidos

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

GET
/orders

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

status?string
from?string
Formatdate-time
to?string
Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/orders"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "order_number": "string",
      "status": "string",
      "delivery_type": "string",
      "destinatario_id": "4a973a49-fb63-494f-92e3-d213b261bff9",
      "notes": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
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/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

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": 1      }    ]  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/orders/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "order_number": "string",
  "status": "string",
  "delivery_type": "string",
  "destinatario_id": "4a973a49-fb63-494f-92e3-d213b261bff9",
  "notes": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "delivery_address": "string",
  "delivery_city": "string",
  "delivery_province": "string",
  "delivery_contact": "string",
  "distribution_order_items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "quantity": 0,
      "vintage_year": 0,
      "notes": "string",
      "products": {
        "name": "string",
        "sku": "string"
      }
    }
  ],
  "distribution_order_attachments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "file_url": "string",
      "file_name": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
PATCH
/orders/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "action": "cancel"  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
POST
/orders/{id}/attachments

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/attachments" \  -F file="string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "file_url": "string",
  "file_name": "string",
  "created_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Cuenta corriente

Saldo actual y movimientos de cuenta (pagos recibidos / fiado).

GET
/balance

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/balance"
{
  "saldo": 0,
  "total_fiado": 0,
  "total_pagado": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/transactions

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

payment_method?string

Filtro exacto (efectivo|tarjeta|transferencia|qr|cheque).

from?string
Formatdate-time
to?string
Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/transactions"
{
  "data": [
    {
      "id": "string",
      "amount": 0,
      "payment_method": "string",
      "description": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Destinatarios

CRUD de destinatarios (lugares donde despacha tu stock).

GET
/destinatarios

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

search?string

Filtro por nombre (ILIKE, substring).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "address": "string",
      "phone": "string",
      "city": "string",
      "province": "string",
      "postal_code": "string",
      "email": "user@example.com",
      "cuit_dni": "string",
      "iva_condition": "string",
      "delivery_schedule": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
POST
/destinatarios

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": "string",
  "phone": "string",
  "city": "string",
  "province": "string",
  "postal_code": "string",
  "email": "user@example.com",
  "cuit_dni": "string",
  "iva_condition": "string",
  "delivery_schedule": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
PATCH
/destinatarios/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "address": "string",
  "phone": "string",
  "city": "string",
  "province": "string",
  "postal_code": "string",
  "email": "user@example.com",
  "cuit_dni": "string",
  "iva_condition": "string",
  "delivery_schedule": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
DELETE
/destinatarios/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://ciervo.tikra.com.ar/api/v1/portal/destinatarios/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

Webhooks

Suscribirte a 16 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

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "http://example.com",
      "description": "string",
      "events": [
        "order.created"
      ],
      "status": "active",
      "consecutive_failures": 0,
      "last_success_at": "2019-08-24T14:15:22Z",
      "last_failure_at": "2019-08-24T14:15:22Z",
      "last_failure_reason": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
POST
/webhooks

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "events": [      "order.created"    ]  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "url": "http://example.com",
  "description": "string",
  "events": [
    "order.created"
  ],
  "status": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "signing_secret": "whsec_<hex>",
  "signing_secret_warning": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "url": "http://example.com",
  "description": "string",
  "events": [
    "order.created"
  ],
  "status": "active",
  "consecutive_failures": 0,
  "last_success_at": "2019-08-24T14:15:22Z",
  "last_failure_at": "2019-08-24T14:15:22Z",
  "last_failure_reason": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
PATCH
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "url": "http://example.com",
  "description": "string",
  "events": [
    "order.created"
  ],
  "status": "active",
  "consecutive_failures": 0,
  "last_success_at": "2019-08-24T14:15:22Z",
  "last_failure_at": "2019-08-24T14:15:22Z",
  "last_failure_reason": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
DELETE
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
POST
/webhooks/{id}/rotate-secret

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate-secret"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "signing_secret": "whsec_<hex>",
  "signing_secret_warning": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
GET
/webhooks/{id}/deliveries

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid

Query Parameters

limit?integer

Tamaño de página (default 50, clamp 1-100).

Default50
Range1 <= value <= 100
cursor?string

Cursor opaco (base64url) tomado del next_cursor de la página anterior. Corrupto → 400 validation/invalid-cursor.

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

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "event_type": "string",
      "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
      "status": "pending",
      "attempts": 0,
      "response_status": 0,
      "duration_ms": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "delivered_at": "2019-08-24T14:15:22Z",
      "next_attempt_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
POST
/webhooks/{id}/deliveries/{delivery_id}/retry

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid
delivery_id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://ciervo.tikra.com.ar/api/v1/portal/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08/retry"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "pending"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "request_id": "req_01hx...",
  "required_scopes": [
    "string"
  ],
  "granted_scopes": [
    "string"
  ]
}

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 <= 200
notes?string
Lengthlength <= 2000
delivery_type?string
Default"entrega"
Value in"entrega" | "retiro"
delivery_address?string
Lengthlength <= 500
delivery_city?string
Lengthlength <= 120
delivery_province?string
Lengthlength <= 120
delivery_contact?string
Lengthlength <= 120
action*string
Value in"cancel"
reason?string
Lengthlength <= 500
file*file
Formatbinary
name*string
Length1 <= length <= 120
address?|
Lengthlength <= 500
city?|
Lengthlength <= 120
province?|
Lengthlength <= 120
postal_code?|
Lengthlength <= 20
phone?|
Lengthlength <= 40
email?|
Formatemail
Lengthlength <= 120
cuit_dni?|
Lengthlength <= 20
iva_condition?|
Lengthlength <= 40
delivery_schedule?|
Lengthlength <= 200
name?string
Length1 <= length <= 120
address?|
Lengthlength <= 500
city?|
Lengthlength <= 120
province?|
Lengthlength <= 120
postal_code?|
Lengthlength <= 20
phone?|
Lengthlength <= 40
email?|
Formatemail
Lengthlength <= 120
cuit_dni?|
Lengthlength <= 20
iva_condition?|
Lengthlength <= 40
delivery_schedule?|
Lengthlength <= 200
url*string
Formaturi
Lengthlength <= 2000
description?string
Lengthlength <= 500
events*array<>
Items1 <= items
url?string
Formaturi
Lengthlength <= 2000
description?|
Lengthlength <= 500
events?array<>
Items1 <= items
status?string
Value in"active" | "paused"