API's voor Wholesale Pricing

Haal een lijst met de Wholesale Pricing-regels van je winkel op met de Public API.

Dit document beschrijft hoe je met de Public API de lijst met Wholesale Pricing-records ophaalt uit de Samita Wholesale-app.

1. Endpoint

Gebruik het volgende API-endpoint om de lijst met Wholesale Pricing op te halen:

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

2. Request headers

Alle API-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 van deze headers ontbreekt, wordt het request geweigerd.

3. Request-parameters (query / body)

Je kunt de volgende parameters opnemen om het API-request aan te passen:

Parameter	Beschrijving	Vereist
`limit`	Bepaalt het maximale aantal records dat in één request wordt teruggegeven	Nee
`query`	Wordt gebruikt om records te zoeken op titel of ID	Nee
`status`	Wordt gebruikt om records te filteren op status	Nee
`sort`	Wordt gebruikt om records te sorteren op aanmaaktijd	Nee

a. limit

Bepaalt het maximale aantal records dat in één request wordt teruggegeven
Moet een numerieke waarde zijn
Minimumwaarde: 1
Maximumwaarde: 20
Optionele parameter
Als het veld leeg blijft, is de standaardwaarde 20

Voorbeeld:

limit=10

b. query

Wordt gebruikt om records te zoeken op titel of ID
Moet een stringwaarde zijn
Maximale lengte: 255 tekens
Optionele parameter

Voorbeeld:

query=pricing rule

c. status

Wordt gebruikt om records te filteren op status
Optionele parameter
Als het veld leeg blijft, geeft de API alle records terug
Als je een waarde opgeeft, worden alleen de volgende waarden geaccepteerd:

Waarde	Beschrijving
`active`	Alleen actieve records
`draft`	Alleen conceptrecords

Elke andere waarde wordt geweigerd.

Voorbeeld:

status=active

d. sort

Wordt gebruikt om records te sorteren op aanmaaktijd
Optionele parameter
Als het veld leeg blijft, worden records gesorteerd met de nieuwst aangemaakte eerst
Er worden maar twee waarden geaccepteerd:

Waarde	Beschrijving
`descrease`	Sorteren van nieuwste naar oudste
`ascrease`	Sorteren van oudste naar nieuwste

Voorbeeld:

sort=descrease

Voorbeeld van een request:

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

4. API-response

De API geeft een van de volgende HTTP-statuscodes terug:

a. Foutmeldingen

401 – Unauthorized

Deze fout treedt op als het request niet correct is geauthenticeerd.

Mogelijke oorzaken:

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

403 – This action is unauthorized

Deze fout treedt op als de API-sleutel onvoldoende machtigingen heeft.

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

View
Create
Update
Delete

Voor de Wholesale Pricing List API is de machtiging View nodig.
Als de API-sleutel geen machtiging View heeft, wordt deze fout teruggegeven.

429 – Too Many Requests

Deze fout treedt op als het request de toegestane limiet voor het aantal requests overschrijdt.

Huidige limieten:

Maximaal 1 request per 5 minuten
Maximaal 50 requests per dag

Als deze limieten worden overschreden, geeft het systeem deze fout terug.

b. Succesvolle response

200 – API Success

Het request is geldig
De authenticatie is geslaagd
De gegevens worden correct teruggegeven
De lijst met Wholesale Pricing wordt geleverd in JSON-formaat

Voorbeeld van een succesvolle API-response:

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

Was dit nuttig?