API:er för Volume Pricing

Det här dokumentet förklarar hur du hämtar en lista över Volume Pricing-poster med det publika API:et.

---

1. Slutpunkt

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

Med den här slutpunkten kan du hämta en lista över Volume Pricing-poster utifrån filtrerings- och sorteringsparametrar.

---

2. Begäranderubriker

Alla förfrågningar måste innehålla följande obligatoriska rubriker:

Rubrik	Beskrivning	Obligatorisk
X-SAMITA-API-KEY	API-nyckel som tillhandahålls i appen Wholesale	Ja
X-SAMITA-SHOP-URL	Shopify-butikens domän i formatet xxx.myshopify.com	Ja
CONTENT-TYPE	Måste vara application/json	Ja

Om någon obligatorisk rubrik saknas eller är ogiltig avvisas förfrågan.

---

3. Begäranparametrar

GET-förfrågan stöder följande valfria frågeparametrar:

---

a. limit

Anger det högsta antalet poster som returneras.

• Måste vara ett tal
• Lägsta värde: 1
• Högsta värde: 20
• Om det lämnas tomt är standardvärdet 20

Exempel:

?limit=10

---

b. query

Söksträng som används för att filtrera poster efter title eller ID.

• Måste vara en sträng
• Maximal längd: 255 tecken

Exempel:

?query=pricing rule

---

c. status

Filtrera poster efter status.

• Kan lämnas tomt för att hämta alla poster

• Om det anges godtas bara följande värden:

  Värde	Beskrivning
  active	Endast aktiva poster
  draft	Endast utkastposter

Exempel:

?status=active

---

d. sort

Sortera poster efter skapandetid.

• Kan lämnas tomt (standard: senaste posterna först)
• Om det anges godtas bara något av följande värden:
  • descrease
  • ascrease

Exempel:

?sort=descrease

---

Fullständigt exempel på förfrågan

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

---

4. API-svar

---

4.1 Felsvar

401 – Unauthorized

Returneras när autentiseringen misslyckas.

Möjliga orsaker:

• Butikens URL saknas
• API-nyckel saknas
• Felaktig butiks-URL
• Felaktig API-nyckel
• API-nyckeln matchar inte butiken

---

403 – This action is unauthorized

Returneras när API-nyckeln inte har tillräckliga behörigheter.

Varje API-nyckel kan tilldelas följande behörigheter:

• View
• Create
• Update
• Delete

API:et List Volume Pricing kräver behörigheten View.

---

429 – Too Many Requests

Returneras när förfrågningsgränsen har överskridits.

Nuvarande gränser:

• Högst 1 förfrågan per 5 minuter
• Högst 50 förfrågningar per dag

---

4.2 Lyckat svar

200 – API Success

Returneras när förfrågan är giltig och har behandlats.

Svaret returnerar en lista över Volume Pricing-poster i JSON-format.

---

Exempel på lyckat API-svar:

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