Docs
Dashboard
On this page

    Sales pauses

    1 endpoint. 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.

    Sales paused by linked status (open and past), with the downtime credited to keys

    GET/v1/store/sales-pauses

    Or name the store: GET /v1/stores/{storeId}/sales-pauses

    catalog:readrole: catalog:readlistSalesPauses

    Parameters

    • productIdprd_… | nullquery

    Response ListSalesPausesResponse

    • pausesSalesPause[]required

    Example

    curl "https://api.shopfa.st/v1/store/sales-pauses" \
      -H "Authorization: Bearer $SHOPFAST_API_KEY"
    const res = await fetch('https://api.shopfa.st/v1/store/sales-pauses', {
      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/sales-pauses",
        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/sales-pauses", 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?