API per Volume Pricing

Questo documento spiega come recuperare un elenco di record Volume Pricing con la Public API.

---

1. Endpoint

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

Questo endpoint permette di recuperare un elenco di record Volume Pricing in base a parametri di filtro e ordinamento.

---

2. Intestazioni della richiesta

Tutte le richieste devono includere le seguenti intestazioni obbligatorie:

Header	Descrizione	Obbligatorio
X-SAMITA-API-KEY	Chiave API fornita nell’app Wholesale	Sì
X-SAMITA-SHOP-URL	Dominio del negozio Shopify nel formato xxx.myshopify.com	Sì
CONTENT-TYPE	Deve essere application/json	Sì

Se manca un’intestazione obbligatoria o non è valida, la richiesta viene rifiutata.

---

3. Parametri della richiesta

La richiesta GET supporta i seguenti parametri di query facoltativi:

---

a. limit

Definisce il numero massimo di record restituiti.

• Deve essere un numero
• Valore minimo: 1
• Valore massimo: 20
• Se lasciato vuoto, il valore predefinito è 20

Esempio:

?limit=10

---

b. query

Stringa di ricerca usata per filtrare i record per titolo o ID.

• Deve essere una stringa
• Lunghezza massima: 255 caratteri

Esempio:

?query=pricing rule

---

c. status

Filtra i record per stato.

• Può essere lasciato vuoto per recuperare tutti i record

• Se indicato, sono accettati solo i seguenti valori:

  Valore	Descrizione
  active	Solo i record attivi
  draft	Solo i record in bozza

Esempio:

?status=active

---

d. sort

Ordina i record in base alla data di creazione.

• Può essere lasciato vuoto (predefinito: prima i record più recenti)
• Se indicato, accetta solo uno dei seguenti valori:
  • descrease
  • ascrease

Esempio:

?sort=descrease

---

Esempio di richiesta completa

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

---

4. Risposta dell’API

---

4.1 Risposte di errore

401 – Unauthorized

Restituito quando l’autenticazione non riesce.

Possibili motivi:

• URL del negozio mancante
• Chiave API mancante
• URL del negozio errato
• Chiave API errata
• La chiave API non corrisponde al negozio

---

403 – This action is unauthorized

Restituito quando la chiave API non ha autorizzazioni sufficienti.

A ogni chiave API possono essere assegnate le seguenti autorizzazioni:

• View
• Create
• Update
• Delete

La List Volume Pricing API richiede l’autorizzazione View.

---

429 – Too Many Requests

Restituito quando viene superato il limite di richieste.

Limiti attuali:

• Massimo 1 richiesta ogni 5 minuti
• Massimo 50 richieste al giorno

---

4.2 Risposta di successo

200 – API Success

Restituito quando la richiesta è valida ed è stata elaborata correttamente.

La risposta restituisce un elenco di record Volume Pricing in formato JSON.

---

Esempio di risposta di successo dell’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"
  }
]