Read a supplier

Any signed in user. Returns one supplier with its contact details and reliability score. Closing a supplier only clears its active flag, so the row stays readable here by its id.

GET/api/v1/suppliers/{supplierId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

supplierIdstringrequired

The supplier id.

Responses

200

The supplier

idstringrequired

namestringrequired

tax_numberstringrequired

contact_personstringrequired

phonestringrequired

emailstringrequired

addressstringrequired

supplier_typestringrequired

lead_time_daysintegerrequired

min -9007199254740991 · max 9007199254740991

reliability_scorenumberrequired

is_activebooleanrequired

created_atstringrequired

updated_atstringrequired

401

Not authenticated

detailstringrequired

404

Supplier not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

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

Parameters

supplierIdpath*The supplier id.

Request

curl -X GET 'http://localhost:8000/api/v1/suppliers/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/suppliers/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/suppliers/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "name": "string",
  "tax_number": "string",
  "contact_person": "string",
  "phone": "string",
  "email": "string",
  "address": "string",
  "supplier_type": "string",
  "lead_time_days": -9007199254740991,
  "reliability_score": 0,
  "is_active": true,
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}