API pour Volume Pricing

Ce document explique comment récupérer une liste d’enregistrements Volume Pricing avec l’API publique.

---

1. Point de terminaison

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

Ce point de terminaison vous permet de récupérer une liste d’enregistrements Volume Pricing selon des paramètres de filtrage et de tri.

---

2. En-têtes de la requête

Toutes les requêtes doivent inclure les en-têtes obligatoires suivants :

En-tête	Description	Obligatoire
X-SAMITA-API-KEY	Clé d’API fournie dans l’application Wholesale	Oui
X-SAMITA-SHOP-URL	Domaine de la boutique Shopify au format xxx.myshopify.com	Oui
CONTENT-TYPE	Doit être application/json	Oui

Si un en-tête obligatoire est absent ou invalide, la requête sera rejetée.

---

3. Paramètres de la requête

La requête GET prend en charge les paramètres de requête facultatifs suivants :

---

a. limit

Définit le nombre maximal d’enregistrements renvoyés.

• Doit être un nombre
• Valeur minimale : 1
• Valeur maximale : 20
• Si le paramètre est vide, la valeur par défaut est 20

Exemple :

?limit=10

---

b. query

Chaîne de recherche utilisée pour filtrer les enregistrements par titre ou par ID.

• Doit être une chaîne
• Longueur maximale : 255 caractères

Exemple :

?query=pricing rule

---

c. status

Filtre les enregistrements par statut.

• Peut rester vide pour récupérer tous les enregistrements

• S’il est fourni, seules les valeurs suivantes sont acceptées :

  Valeur	Description
  active	Uniquement les enregistrements actifs
  draft	Uniquement les enregistrements en brouillon

Exemple :

?status=active

---

d. sort

Trie les enregistrements par date de création.

• Peut rester vide (par défaut : les enregistrements les plus récents en premier)
• S’il est fourni, n’accepte qu’une des valeurs suivantes :
  • descrease
  • ascrease

Exemple :

?sort=descrease

---

Exemple de requête complète

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

---

4. Réponse de l’API

---

4.1 Réponses d’erreur

401 – Unauthorized

Renvoyée lorsque l’authentification échoue.

Causes possibles :

• URL de la boutique manquante
• Clé d’API manquante
• URL de la boutique incorrecte
• Clé d’API incorrecte
• La clé d’API ne correspond pas à la boutique

---

403 – This action is unauthorized

Renvoyée lorsque la clé d’API ne dispose pas des autorisations suffisantes.

Les autorisations suivantes peuvent être attribuées à chaque clé d’API :

• View
• Create
• Update
• Delete

L’API List Volume Pricing nécessite l’autorisation View.

---

429 – Too Many Requests

Renvoyée lorsque la limite de requêtes est dépassée.

Limites actuelles :

• Maximum de 1 requête toutes les 5 minutes
• Maximum de 50 requêtes par jour

---

4.2 Réponse en cas de succès

200 – API Success

Renvoyée lorsque la requête est valide et traitée avec succès.

La réponse renvoie une liste d’enregistrements Volume Pricing au format JSON.

---

Exemple de réponse réussie de l’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"
  }
]