API:er för Wholesale Pricing

Hämta en lista över butikens Wholesale Pricing-regler med det publika API:et.

Det här dokumentet beskriver hur du använder det publika API:et för att hämta listan över Wholesale Pricing-poster från appen Samita Wholesale.

1. Slutpunkt

Om du vill hämta listan över Wholesale Pricing använder du följande API-slutpunkt:

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

2. Begäranderubriker

Alla API-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 av dessa rubriker saknas avvisas förfrågan.

3. Begäranparametrar (fråga / kropp)

Följande parametrar kan tas med för att anpassa API-förfrågan:

Parameter	Beskrivning	Obligatorisk
`limit`	Anger det högsta antalet poster som returneras i en förfrågan	Nej
`query`	Används för att söka bland poster efter titel eller ID	Nej
`status`	Används för att filtrera poster efter status	Nej
`sort`	Används för att sortera poster efter skapandetid	Nej

a. limit

Anger det högsta antalet poster som returneras i en förfrågan
Måste vara ett numeriskt värde
Lägsta värde: 1
Högsta värde: 20
Valfri parameter
Om det lämnas tomt är standardvärdet 20

Exempel:

limit=10

b. query

Används för att söka bland poster efter titel eller ID
Måste vara ett strängvärde
Maximal längd: 255 tecken
Valfri parameter

Exempel:

query=pricing rule

c. status

Används för att filtrera poster efter status
Valfri parameter
Om det lämnas tomt returnerar API:et alla poster
Om det anges godtas bara följande värden:

Värde	Beskrivning
`active`	Endast aktiva poster
`draft`	Endast utkastposter

Alla andra värden avvisas.

Exempel:

status=active

d. sort

Används för att sortera poster efter skapandetid
Valfri parameter
Om det lämnas tomt sorteras posterna med senast skapade först
Endast två värden godtas:

Värde	Beskrivning
`descrease`	Sortera från nyast till äldst
`ascrease`	Sortera från äldst till nyast

Exempel:

sort=descrease

Exempel på förfrågan:

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

4. API-svar

API:et returnerar någon av följande HTTP-statuskoder:

a. Felsvar

401 – Unauthorized

Det här felet uppstår när förfrågan inte är korrekt autentiserad.

Möjliga orsaker:

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

403 – This action is unauthorized

Det här felet uppstår 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 för listan över Wholesale Pricing kräver behörigheten View.
Om API-nyckeln saknar behörigheten View returneras det här felet.

429 – Too Many Requests

Det här felet uppstår när förfrågan överskrider den tillåtna förfrågningsgränsen.

Nuvarande förfrågningsgränser:

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

Om dessa gränser överskrids returnerar systemet det här felet.

b. Lyckat svar

200 – API Success

Förfrågan är giltig
Autentiseringen lyckades
Data returneras korrekt
Listan över Wholesale Pricing lämnas i JSON-format

Exempel på lyckat API-svar:

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

Var det här till hjälp?