Docs
Dashboard
On this page

    Reseller program

    2 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.

    Wholesale settings, tiers and the application link

    GET/v1/store/reseller-program

    Or name the store: GET /v1/stores/{storeId}/reseller-program

    marketing:readgetResellerProgram

    Response GetResellerProgramResponse

    • settingsResellerSettingsrequired
    • tiersResellerTier[]required
    • applyUrlstringrequired

    Example

    curl "https://api.shopfa.st/v1/store/reseller-program" \
      -H "Authorization: Bearer $SHOPFAST_API_KEY"
    const res = await fetch('https://api.shopfa.st/v1/store/reseller-program', {
      method: 'GET',
      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(
        "GET",
        "https://api.shopfa.st/v1/store/reseller-program",
        headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
    )
    res.raise_for_status()
    data = res.json()
    req, _ := http.NewRequest("GET", "https://api.shopfa.st/v1/store/reseller-program", 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.

    Turn wholesale on or off and edit the pitch

    PUT/v1/store/reseller-program

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

    marketing:writeupdateResellerProgram

    Body

    • enabledboolean
    • pitchstring

    Response UpdateResellerProgramResponse

    • settingsResellerSettingsrequired
    • tiersResellerTier[]required
    • applyUrlstringrequired

    Example

    curl -X PUT "https://api.shopfa.st/v1/store/reseller-program" \
      -H "Authorization: Bearer $SHOPFAST_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "enabled": true,
      "pitch": "Buy license keys in bulk at wholesale prices and resell them to your own customers."
    }'
    const res = await fetch('https://api.shopfa.st/v1/store/reseller-program', {
      method: 'PUT',
      headers: {
        Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({
        "enabled": true,
        "pitch": "Buy license keys in bulk at wholesale prices and resell them to your own customers."
      }),
    });
    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-program",
        headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
        json={
          "enabled": True,
          "pitch": "Buy license keys in bulk at wholesale prices and resell them to your own customers."
        },
    )
    res.raise_for_status()
    data = res.json()
    req, _ := http.NewRequest("PUT", "https://api.shopfa.st/v1/store/reseller-program", strings.NewReader(`{
      "enabled": true,
      "pitch": "Buy license keys in bulk at wholesale prices and resell them to your own customers."
    }`))
    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.

    Was this page helpful?