Docs
Dashboard
On this page

    Reseller tiers

    3 endpoints. Each needs an API key or OAuth token with the scope shown; the key already names its store, so paths start at /v1/store. Generated from the live contract; also in openapi.json.

    Add a pricing tier

    POST/v1/store/reseller-tiers

    Or name the store: POST /v1/stores/{storeId}/reseller-tiers

    marketing:writecreateResellerTier

    Body

    • namestringrequired
    • discountBpsintegerrequired
    • minQuantityintegerrequired

    Response ResellerTier

    • idResellerTierIdrequired
    • namestringrequired
    • discountBpsintegerrequired
    • minQuantityintegerrequired
    • resellersintegerrequired

    Example

    curl -X POST "https://api.shopfa.st/v1/store/reseller-tiers" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "discountBps": 100,
  "minQuantity": 1
}'
    const res = await fetch('https://api.shopfa.st/v1/store/reseller-tiers', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "discountBps": 100,
    "minQuantity": 1
  }),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();
    import os, requests

res = requests.request(
    "POST",
    "https://api.shopfa.st/v1/store/reseller-tiers",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    json={
      "name": "string",
      "discountBps": 100,
      "minQuantity": 1
    },
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("POST", "https://api.shopfa.st/v1/store/reseller-tiers", strings.NewReader(`{
  "name": "string",
  "discountBps": 100,
  "minQuantity": 1
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Change a pricing tier

    PUT/v1/store/reseller-tiers/{tierId}

    Or name the store: PUT /v1/stores/{storeId}/reseller-tiers/{tierId}

    marketing:writeupdateResellerTier

    Parameters

    • tierIdrtr_…pathrequired

    Body

    • namestringrequired
    • discountBpsintegerrequired
    • minQuantityintegerrequired

    Response ResellerTier

    • idResellerTierIdrequired
    • namestringrequired
    • discountBpsintegerrequired
    • minQuantityintegerrequired
    • resellersintegerrequired

    Example

    curl -X PUT "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "discountBps": 100,
  "minQuantity": 1
}'
    const res = await fetch('https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "discountBps": 100,
    "minQuantity": 1
  }),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();
    import os, requests

res = requests.request(
    "PUT",
    "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    json={
      "name": "string",
      "discountBps": 100,
      "minQuantity": 1
    },
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("PUT", "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk", strings.NewReader(`{
  "name": "string",
  "discountBps": 100,
  "minQuantity": 1
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Delete a tier nobody is on

    DELETE/v1/store/reseller-tiers/{tierId}

    Or name the store: DELETE /v1/stores/{storeId}/reseller-tiers/{tierId}

    marketing:writedeleteResellerTier

    Parameters

    • tierIdrtr_…pathrequired

    Response Ok

    • okbooleanrequired

    Example

    curl -X DELETE "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"
    const res = await fetch('https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
  },
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();
    import os, requests

res = requests.request(
    "DELETE",
    "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()
    req, _ := http.NewRequest("DELETE", "https://api.shopfa.st/v1/store/reseller-tiers/rtr_0123456789abcdefghjk", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)
    Try it with your key

    Use a test key on a development store. The key stays in this tab (sessionStorage) and is sent only to the base URL above.

    Was this page helpful?
    Report an issue