API pour la tarification de gros

Ce document décrit comment utiliser l’API publique pour récupérer la liste des enregistrements de tarification de gros de l’application Samita Wholesale.

---

1. Point de terminaison

Pour récupérer la liste des tarifications de gros, utilisez le point de terminaison d’API suivant :

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

---

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

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

En-tête	Description	Obligatoire
X-SAMITA-API-KEY	Clé 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 l’un de ces en-têtes est manquant, la requête est rejetée.

---

3. Paramètres de la requête (query / corps)

Les paramètres suivants peuvent être inclus pour personnaliser la requête API :

Paramètre	Description	Obligatoire
limit	Définit le nombre maximal d’enregistrements renvoyés par requête	Non
query	Permet de rechercher des enregistrements par titre ou par ID	Non
status	Permet de filtrer les enregistrements par statut	Non
sort	Permet de trier les enregistrements par date de création	Non

a. limit

• Définit le nombre maximal d’enregistrements renvoyés par requête
• Doit être une valeur numérique
• Valeur minimale : 1
• Valeur maximale : 20
• Paramètre facultatif
• S’il est laissé vide, la valeur par défaut est 20

Exemple :

limit=10

---

b. query

• Permet de rechercher des enregistrements par titre ou par ID
• Doit être une chaîne de caractères
• Longueur maximale : 255 caractères
• Paramètre facultatif

Exemple :

query=pricing rule

---

c. status

• Permet de filtrer les enregistrements par statut
• Paramètre facultatif
• S’il est laissé vide, l’API renvoie tous les enregistrements
• S’il est renseigné, seules les valeurs suivantes sont acceptées :

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

Toute autre valeur est rejetée.

Exemple :

status=active

---

d. sort

• Permet de trier les enregistrements par date de création
• Paramètre facultatif
• S’il est laissé vide, les enregistrements sont triés du plus récent au plus ancien
• Seules deux valeurs sont acceptées :

Valeur	Description
descrease	Tri du plus récent au plus ancien
ascrease	Tri du plus ancien au plus récent

Exemple :

sort=descrease

---

Exemple de requête :

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

4. Réponse de l’API

L’API renvoie l’un des codes d’état HTTP suivants :

a. Réponses d’erreur

401 – Non autorisé

Cette erreur se produit lorsque la requête n’est pas correctement authentifiée.

Causes possibles :

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

---

403 – Cette action n’est pas autorisée

Cette erreur se produit lorsque la clé API ne dispose pas des autorisations suffisantes.

Chaque clé API peut recevoir les autorisations suivantes :

• View
• Create
• Update
• Delete

L’API de liste des tarifications de gros nécessite l’autorisation View.
Si la clé API n’a pas l’autorisation View, cette erreur est renvoyée.

---

429 – Trop de requêtes

Cette erreur se produit lorsque la requête dépasse la limite de débit autorisée.

Limites de débit actuelles :

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

Si ces limites sont dépassées, le système renvoie cette erreur.

---

b. Réponse de succès

200 – Succès de l’API

• La requête est valide
• L’authentification a réussi
• Les données sont renvoyées correctement
• La liste des tarifications de gros est fournie au format JSON

---

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