APIs para Volume Pricing

Este documento explica cómo obtener una lista de registros de Volume Pricing con la Public API.

---

1. Endpoint

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

Este endpoint permite obtener una lista de registros de Volume Pricing según los parámetros de filtrado y ordenación.

---

2. Encabezados de la solicitud

Todas las solicitudes deben incluir los siguientes encabezados obligatorios:

Header	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 algún encabezado obligatorio o no es válido, la solicitud se rechazará.

---

3. Parámetros de la solicitud

La solicitud GET admite los siguientes parámetros de consulta opcionales:

---

a. limit

Define el número máximo de registros devueltos.

• Debe ser un número
• Valor mínimo: 1
• Valor máximo: 20
• Si se deja vacío, el valor predeterminado es 20

Ejemplo:

?limit=10

---

b. query

Cadena de búsqueda usada para filtrar los registros por título o ID.

• Debe ser una cadena de texto
• Longitud máxima: 255 caracteres

Ejemplo:

?query=pricing rule

---

c. status

Filtra los registros por estado.

• Se puede dejar vacío para obtener todos los registros

• Si se indica, solo se aceptan los siguientes valores:

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

Ejemplo:

?status=active

---

d. sort

Ordena los registros por fecha de creación.

• Se puede dejar vacío (valor predeterminado: primero los registros más recientes)
• Si se indica, solo acepta uno de los siguientes valores:
  • descrease
  • ascrease

Ejemplo:

?sort=descrease

---

Ejemplo de solicitud completa

GET https://wholesale.samita.io/api/v1/volume-pricings?limit=10&status=active&sort=descrease

---

4. Respuesta de la API

---

4.1 Respuestas de error

401 – Unauthorized

Se devuelve cuando falla la autenticación.

Posibles motivos:

• Falta la URL de la tienda
• Falta la clave de API
• La URL de la tienda es incorrecta
• La clave de API es incorrecta
• La clave de API no coincide con la tienda

---

403 – This action is unauthorized

Se devuelve 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 List Volume Pricing API requiere el permiso View.

---

429 – Too Many Requests

Se devuelve cuando se supera el límite de solicitudes.

Límites actuales:

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

---

4.2 Respuesta correcta

200 – API Success

Se devuelve cuando la solicitud es válida y se procesa correctamente.

La respuesta devuelve una lista de registros de Volume Pricing en formato JSON.

---

Ejemplo de respuesta correcta de la API:

[
  {
    "id": 1,
    "title": "New Volume Pricing",
    "status": true,
    "type": "quantity",
    "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,
        "duplicated": false,
        "variant_pricing": true,
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "discount_groups": [
          {
            "name": "all",
            "type": "percent",
            "value": "10"
          }
        ],
        "variants": [
          {
            "id": 46747346763943,
            "duplicated": false,
            "from_qty": "0",
            "from_amount": "0",
            "to_qty": "10",
            "to_amount": "0",
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_method": "variant",
    "discount_groups": [
      {
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "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"
  }
]