Public APIs

1. Alcance de uso de la API

a. Funciones compatibles con la API

La Public API permite interactuar con las funciones principales de la aplicación Wholesale, entre ellas:

• Funciones principales: Wholesale Pricing, Volume Pricing, Registration form, Quick Order Form, Quick Buy Collection, Quick Buy Variant
• Funciones complementarias: Order Limit, Shipping Rate, Extra Fee, Payment Term (próximamente)

b. Métodos compatibles

La API admite operaciones CRUD completas con los siguientes métodos HTTP:

• GET – Consultar datos
• POST – Crear datos nuevos
• PUT – Actualizar datos existentes
• DELETE – Eliminar datos

A las claves de API se les pueden conceder los siguientes niveles de permiso: Read Only/Write Only, Read & Write

Las acciones compatibles incluyen: Get list - Get item - Create item - Update item - Delete item

c. Planes de Shopify compatibles:

La Public API de la aplicación Wholesale está disponible para las tiendas de Shopify que cumplan los siguientes requisitos:

• Debe ser una tienda de producción (no se aplica a tiendas de desarrollo ni de prueba)
• Debe tener contratado el plan Gold

---

2. Autenticación

Todas las solicitudes a la API deben autenticarse correctamente antes de procesarse.

a. Parámetros obligatorios

Cada solicitud a la API debe incluir los siguientes parámetros obligatorios:

Parámetro	Descripción
shop	Dominio de la tienda de Shopify (por ejemplo, mystore.myshopify.com)
api_key	Clave de API generada en la aplicación Wholesale

Si falta alguno de estos parámetros, la solicitud se rechazará.

b. Gestión de las claves de API

Las claves de API se crean y gestionan directamente en la interfaz de administración de la aplicación Wholesale.
Quien administra la tienda puede configurar permisos específicos para cada clave de API: Read only/Write only, Read & Write

---

3. Estructura de la API y formato de respuesta

a. Endpoint de la API

Todas las solicitudes a la API deben usar la siguiente URL base:

https://wholesale.samita.io/v1/

b. Endpoints específicos de cada función

Cada grupo de funciones tiene su propio endpoint. Por ejemplo:

• Función Wholesale:

  https://wholesale.samita.io/v1/wholesale/

• Función Volume Pricing:

  https://wholesale.samita.io/v1/volume/

(Los endpoints reales pueden variar según la funcionalidad concreta).

c. Parámetros de consulta compatibles

La API admite varios parámetros de consulta comunes:

Parámetro	Descripción
status	Estado de los registros
page	Número de página para la paginación
limit	Número de registros por página
sort	Criterio de ordenación
query	Condición de búsqueda o filtro

Ejemplo de solicitud:

GET /wholesale?page=1&limit=20&sort=created_at

---

4. Códigos de respuesta

Cada solicitud a la API devolverá uno de los siguientes códigos de estado:

a. Respuestas de error habituales

401 – Unauthorized

Posibles motivos:

• Falta la URL de la tienda
• Falta la clave de API
• URL de la tienda no válida
• Clave de API no válida
• La clave de API no corresponde a la tienda

---

403 – This action is unauthorized

• La clave de API no tiene permiso para realizar la acción solicitada
• Permisos insuficientes para View / Create / Update / Delete

---

429 – Too Many Requests

• Se superó el límite de solicitudes
• La frecuencia de llamadas a la API supera el límite permitido

---

b. Respuesta correcta

200 – Success

• La solicitud es válida
• La acción de la API se ejecutó correctamente
• Los datos se devuelven en el formato correcto

---

5. Límite de solicitudes

Para garantizar el rendimiento y la estabilidad del sistema, el uso de la API está sujeto a un límite diario de solicitudes. Ya no hay un límite por solicitud ni por intervalos cortos: puedes llamar a la API tantas veces como necesites mientras no superes la cuota diaria de tu plan.

El límite diario depende del plan de precios de la tienda:

Plan	Límite diario de solicitudes
Free	5 solicitudes/día
Starter	50 solicitudes/día
Growth	250 solicitudes/día
Enterprise	500 solicitudes/día

El contador diario se restablece a medianoche (hora del servidor) cada día.

Si se supera el límite diario, el sistema devolverá:

429 – Too Many Requests

{
  "message": "Daily request limit exceeded (X requests/day)."
}