APIs de Wholesale Pricing

Este documento describe cómo usar la Public API para obtener la lista de registros de Wholesale Pricing de la aplicación Samita Wholesale.

---

1. Endpoint

Para obtener la lista de Wholesale Pricing, usa el siguiente endpoint de la API:

GET - https://wholesale.samita.io/api/v1/wholesale-pricings

---

2. Encabezados de la solicitud

Todas las solicitudes a la API deben incluir los siguientes encabezados obligatorios:

Encabezado	Descripción	Obligatorio
X-SAMITA-API-KEY	Clave de API proporcionada en la aplicación Wholesale	Sí
X-SAMITA-SHOP-URL	Dominio de la tienda de Shopify con el formato xxx.myshopify.com	Sí
CONTENT-TYPE	Debe ser application/json	Sí

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

---

3. Parámetros de la solicitud (consulta / cuerpo)

Puedes incluir los siguientes parámetros para personalizar la solicitud a la API:

Parámetro	Descripción	Obligatorio
limit	Define el número máximo de registros devueltos en una solicitud	No
query	Sirve para buscar registros por título o ID	No
status	Sirve para filtrar registros por estado	No
sort	Sirve para ordenar registros por fecha de creación	No

a. limit

• Define el número máximo de registros devueltos en una solicitud
• Debe ser un valor numérico
• Valor mínimo: 1
• Valor máximo: 20
• Parámetro opcional
• Si se deja vacío, el valor predeterminado será 20

Ejemplo:

limit=10

---

b. query

• Sirve para buscar registros por título o ID
• Debe ser una cadena de texto
• Longitud máxima: 255 caracteres
• Parámetro opcional

Ejemplo:

query=pricing rule

---

c. status

• Sirve para filtrar registros por estado
• Parámetro opcional
• Si se deja vacío, la API devolverá todos los registros
• Si se indica, solo se aceptan los siguientes valores:

Valor	Descripción
active	Solo registros activos
draft	Solo registros en borrador

Cualquier otro valor se rechazará.

Ejemplo:

status=active

---

d. sort

• Sirve para ordenar registros por fecha de creación
• Parámetro opcional
• Si se deja vacío, los registros se ordenarán del más reciente al más antiguo
• Solo se aceptan dos valores:

Valor	Descripción
descrease	Ordena del más reciente al más antiguo
ascrease	Ordena del más antiguo al más reciente

Ejemplo:

sort=descrease

---

Ejemplo de solicitud:

GET /wholesale-pricing?page=1&limit=20&status=active&sort=descrease

4. Respuesta de la API

La API devolverá uno de los siguientes códigos de estado HTTP:

a. Respuestas de error

401 – Unauthorized

Este error se produce cuando la solicitud no está autenticada correctamente.

Posibles motivos:

• Falta la URL de la tienda
• Falta la clave de API
• URL de la tienda incorrecta
• Clave de API incorrecta
• La clave de API no corresponde a la tienda indicada

---

403 – This action is unauthorized

Este error se produce cuando la clave de API no tiene permisos suficientes.

A cada clave de API se le pueden asignar los siguientes permisos:

• View
• Create
• Update
• Delete

La API de lista de Wholesale Pricing requiere el permiso View.
Si la clave de API no tiene el permiso View, se devolverá este error.

---

429 – Too Many Requests

Este error se produce cuando la solicitud supera el límite de solicitudes permitido.

Límites de solicitudes actuales:

• Máximo 1 solicitud cada 5 minutos
• Máximo 50 solicitudes al día

Si se superan estos límites, el sistema devolverá este error.

---

b. Respuesta correcta

200 – API Success

• La solicitud es válida
• La autenticación es correcta
• Los datos se devuelven correctamente
• La lista de Wholesale Pricing se entrega en formato JSON

---

Ejemplo de respuesta correcta de la API:

[
  {
    "id": 1,
    "title": "New Wholesale Pricing",
    "status": true,
    "apply_customer": {
      "type": "all",
      "tags": []
    },
    "exclude_customer": {
      "type": "none",
      "tags": []
    },
    "apply_product": {
      "type": "all",
      "product_ids": [],
      "product_tags": [],
      "collection_ids": [],
      "apply_for_variants": false
    },
    "exclude_product": {
      "type": "none",
      "product_ids": [],
      "collection_ids": []
    },
    "discount_for_variants": [
      {
        "id": 8516448190631,
        "variant_pricing": true,
        "variants": [
          {
            "id": 46747346763943,
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_group": {
      "type": "percent",
      "value": "10"
    },
    "active_date": {
      "types": [],
      "start_at": "",
      "end_at": ""
    },
    "created_at": "2026-01-15T10:00:00",
    "updated_at": "2026-01-15T10:00:00"
  }
]