Reseller orders

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.

Bulk orders from resellers

GET/v1/store/reseller-orders

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

marketing:readlistResellerOrders

Parameters

resellerIdrsl_… | nullquery

Response ListResellerOrdersResponse

itemsResellerOrder[]required

Example

curl "https://api.shopfa.st/v1/store/reseller-orders" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"

const res = await fetch('https://api.shopfa.st/v1/store/reseller-orders', {
  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-orders",
    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-orders", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)

Try it with your key

API base URLAPI key or token

resellerId

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

Cancel an unpaid bulk order

POST/v1/store/reseller-orders/{resellerOrderId}/cancel

Or name the store: POST /v1/stores/{storeId}/reseller-orders/{resellerOrderId}/cancel

marketing:writecancelResellerOrder

Parameters

resellerOrderIdrso_…pathrequired

Response ResellerOrder

idResellerOrderIdrequired
resellerIdResellerIdrequired
resellerNamestringrequired
productIdProductIdrequired
productNamestringrequired
quantityintegerrequired
unitPriceMinorMinorUnitsrequired
listUnitPriceMinorMinorUnitsrequired
totalMinorMinorUnitsrequired
currencyCurrencyCoderequired

6 more fields

statusResellerOrderStatusrequired
payUrlstringrequired
orderIdOrderId | nullrequired
orderNumberstringrequired
keysDeliveredintegerrequired
createdAtTimestamprequired

Example

curl -X POST "https://api.shopfa.st/v1/store/reseller-orders/rso_0123456789abcdefghjk/cancel" \
  -H "Authorization: Bearer $SHOPFAST_API_KEY"

const res = await fetch('https://api.shopfa.st/v1/store/reseller-orders/rso_0123456789abcdefghjk/cancel', {
  method: 'POST',
  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(
    "POST",
    "https://api.shopfa.st/v1/store/reseller-orders/rso_0123456789abcdefghjk/cancel",
    headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()

req, _ := http.NewRequest("POST", "https://api.shopfa.st/v1/store/reseller-orders/rso_0123456789abcdefghjk/cancel", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)

Try it with your key

API base URLAPI key or token

resellerOrderId

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