API's voor Volume Pricing

Dit document legt uit hoe je een lijst met Volume Pricing-records ophaalt met de Public API.

---

1. Endpoint

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

Met dit endpoint haal je een lijst met Volume Pricing-records op op basis van filter- en sorteerparameters.

---

2. Request headers

Alle requests moeten de volgende vereiste headers bevatten:

Header	Beschrijving	Vereist
X-SAMITA-API-KEY	API-sleutel uit de Wholesale-app	Ja
X-SAMITA-SHOP-URL	Shopify-shopdomein in het formaat xxx.myshopify.com	Ja
CONTENT-TYPE	Moet application/json zijn	Ja

Als een vereiste header ontbreekt of ongeldig is, wordt het request geweigerd.

---

3. Request-parameters

Het GET-request ondersteunt de volgende optionele queryparameters:

---

a. limit

Bepaalt het maximale aantal records dat wordt teruggegeven.

• Moet een getal zijn
• Minimumwaarde: 1
• Maximumwaarde: 20
• Als het veld leeg blijft, is de standaardwaarde 20

Voorbeeld:

?limit=10

---

b. query

Zoekreeks om records te filteren op titel of ID.

• Moet een string zijn
• Maximale lengte: 255 tekens

Voorbeeld:

?query=pricing rule

---

c. status

Filter records op status.

• Kan leeg blijven om alle records op te halen

• Als je een waarde opgeeft, worden alleen de volgende waarden geaccepteerd:

  Waarde	Beschrijving
  active	Alleen actieve records
  draft	Alleen conceptrecords

Voorbeeld:

?status=active

---

d. sort

Sorteer records op aanmaaktijd.

• Kan leeg blijven (standaard: nieuwste records eerst)
• Als je een waarde opgeeft, wordt alleen een van de volgende waarden geaccepteerd:
  • descrease
  • ascrease

Voorbeeld:

?sort=descrease

---

Voorbeeld van een volledig request

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

---

4. API-response

---

4.1 Foutmeldingen

401 – Unauthorized

Wordt teruggegeven als de authenticatie mislukt.

Mogelijke oorzaken:

• Ontbrekende shop-URL
• Ontbrekende API-sleutel
• Onjuiste shop-URL
• Onjuiste API-sleutel
• API-sleutel komt niet overeen met de shop

---

403 – This action is unauthorized

Wordt teruggegeven als de API-sleutel onvoldoende machtigingen heeft.

Aan elke API-sleutel kunnen de volgende machtigingen worden toegewezen:

• View
• Create
• Update
• Delete

De List Volume Pricing API vereist de machtiging View.

---

429 – Too Many Requests

Wordt teruggegeven als de limiet voor het aantal requests is overschreden.

Huidige limieten:

• Maximaal 1 request per 5 minuten
• Maximaal 50 requests per dag

---

4.2 Succesvolle response

200 – API Success

Wordt teruggegeven als het request geldig is en succesvol is verwerkt.

De response geeft een lijst met Volume Pricing-records terug in JSON-formaat.

---

Voorbeeld van een succesvolle API-response:

[
  {
    "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"
  }
]