Ir al contenido
OrderFastOrderFast API

Overview

OrderFast API v1 1.0

Sección titulada «OrderFast API v1 1.0»

API pública de OrderFast para integradores (/v1 y /v2).

Autenticación

Authorization: Bearer of_live_xxxxxxxxxxxxxxxxx

Usá el botón Authorize e ingresá la API Key (sin el prefijo Bearer).

Versiones

  • v1 — API REST estándar
  • v2 — API ERP/POS (tags con prefijo v2)

Respuestas

  • Éxito: { "data": ... }
  • Listados: { "data": [...], "pagination": { "limit", "offset", "total" } }
  • Error: { "error": { "code", "message", "request_id" } }

Paginación

limit (default 50, max 100) y offset (default 0).

Idempotencia

POST /v1/orders, POST /v2/orders y syncs batch requieren header Idempotency-Key.

Specs

Information

  • OpenAPI version: 3.0.0

Operations

Sección titulada «Operations»
GET
/health
GET
/v1/locations
GET
/v1/products
POST
/v1/products
GET
/v1/products/{id}
DELETE
/v1/products/{id}
PATCH
/v1/products/{id}
GET
/v1/categories
POST
/v1/categories
GET
/v1/categories/{id}
DELETE
/v1/categories/{id}
PATCH
/v1/categories/{id}
GET
/v1/orders
POST
/v1/orders
GET
/v1/orders/{id}
PATCH
/v1/orders/{id}/status
GET
/v1/payments
GET
/v1/payments/{id}
GET
/v1/payment-methods
GET
/v1/products/{id}/stock
PATCH
/v1/products/{id}/stock
GET
/v1/webhooks
POST
/v1/webhooks
DELETE
/v1/webhooks/{id}
PATCH
/v1/webhooks/{id}
POST
/v1/webhooks/{id}/test
GET
/v1/webhooks/{id}/deliveries

Authentication

Sección titulada «Authentication»

api-key

Sección titulada «api-key»

API Key de OrderFast (of_live_… / of_test_…)

Security scheme type: http

Bearer format: API Key