Archive a supplier

Suppliers archive rather than delete, because products keep referencing their IDs.

Archiving relinks every product and variant that would be left without a supplier to the hidden Default, and purges this supplier’s per-supplier prices in the background. Repeating the call on an already-archived supplier is a no-op, so a retry is safe. The hidden Default itself can’t be archived.

POST/api/v1/suppliers/{id}/archive

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

Responses

200Archived

supplierIdstringrequired

The supplier this result is about.

archivedbooleanrequired

True after archiving, false after restoring.

relinkedProductsintegerrequired

Products that fell back to the hidden Default because this was their only supplier.

relinkedVariantsintegerrequired

Variants that fell back to the hidden Default because this was their only supplier.

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

404The requested resource doesn't exist or belongs to a different tenant.

errorstringrequired

409The request is well formed, but it conflicts with the current state: a name already taken, a row the app protects (the hidden Default supplier, a preset colour or category), or a staff member who has an account.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X POST "https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3/archive" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3/archive", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3/archive",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "supplierId": "sup_77p3v2k6m4t1r5z9c8w0y7b3",
  "archived": true,
  "relinkedProducts": 0,
  "relinkedVariants": 0
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}