Snapshot the catalogue

Any signed in user. Returns the catalogue a till mirrors, with max_rev as the pull cursor. An admin gets every branch and user, a branch caller only its own, and no password hash.

GET/api/v1/sync/snapshot

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Responses

200

The catalogue snapshot

max_revintegerrequired

min -9007199254740991 · max 9007199254740991

branchesobject[]required

Show properties

Array of object

idstringrequired

codestringrequired

namestringrequired

citystringrequired

vat_numberstringrequired

addressstringrequired

image_urlstringrequired

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_atstringrequired

medicinesobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

generic_namestringrequired

barcodestringrequired

categorystringrequired

formstringrequired

strengthstringrequired

unitstringrequired

selling_pricenumberrequired

stock_quantitynumberrequired

low_stock_thresholdnumberrequired

requires_prescriptionintegerrequired

min -9007199254740991 · max 9007199254740991

is_controlledintegerrequired

min -9007199254740991 · max 9007199254740991

control_schedulestringrequired

vat_categorystringrequired

requires_cold_chainintegerrequired

min -9007199254740991 · max 9007199254740991

sfda_registration_nostringrequired

max_public_pricenumberrequired

image_keystringrequired

image_urlstringrequired

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_atstringrequired

suppliersobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

tax_numberstringrequired

contact_personstringrequired

phonestringrequired

emailstringrequired

addressstringrequired

image_urlstringrequired

supplier_typestringrequired

lead_time_daysnumberrequired

reliability_scorenumberrequired

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_atstringrequired

couponsobject[]required

Show properties

Array of object

idstringrequired

codestringrequired

typestringrequired

discount_typestringrequired

discount_valuenumberrequired

descriptionstringrequired

applies_tostringrequired

applies_to_idstring | nullrequired

valid_fromstring | nullrequired

valid_untilstring | nullrequired

max_usesnumber | nullrequired

image_urlstringrequired

usage_countnumberrequired

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_bystringrequired

created_atstringrequired

updated_atstringrequired

customersobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

phonestringrequired

national_idstringrequired

notesstringrequired

image_urlstringrequired

created_atstringrequired

updated_atstringrequired

is_credit_allowedintegerrequired

min -9007199254740991 · max 9007199254740991

credit_limitnumberrequired

current_balancenumberrequired

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

usersobject[]required

Show properties

Array of object

idstringrequired

branch_idstringrequired

emailstringrequired

full_namestringrequired

phonestringrequired

rolestringrequired

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

last_login_atstring | nullrequired

created_atstringrequired

updated_atstringrequired

batchesobject[]required

Show properties

Array of object

idstringrequired

medicine_idstringrequired

branch_idstringrequired

supplier_idstring | nullrequired

batch_numberstringrequired

expiry_datestringrequired

manufacturing_datestring | nullrequired

qty_receivednumberrequired

qty_remainingnumberrequired

unit_costnumberrequired

statusstringrequired

sfda_statusstringrequired

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

categoriesobject[]required

Show properties

Array of object

slugstringrequired

namestringrequired

created_atstringrequired

401

Not authenticated

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

Request

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

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

import requests

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

Response

{
  "max_rev": -9007199254740991,
  "branches": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "city": "string",
      "vat_number": "string",
      "address": "string",
      "image_url": "string",
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "medicines": [
    {
      "id": "string",
      "name": "string",
      "generic_name": "string",
      "barcode": "string",
      "category": "string",
      "form": "string",
      "strength": "string",
      "unit": "string",
      "selling_price": 0,
      "stock_quantity": 0,
      "low_stock_threshold": 0,
      "requires_prescription": -9007199254740991,
      "is_controlled": -9007199254740991,
      "control_schedule": "string",
      "vat_category": "string",
      "requires_cold_chain": -9007199254740991,
      "sfda_registration_no": "string",
      "max_public_price": 0,
      "image_key": "string",
      "image_url": "string",
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "suppliers": [
    {
      "id": "string",
      "name": "string",
      "tax_number": "string",
      "contact_person": "string",
      "phone": "string",
      "email": "string",
      "address": "string",
      "image_url": "string",
      "supplier_type": "string",
      "lead_time_days": 0,
      "reliability_score": 0,
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "type": "string",
      "discount_type": "string",
      "discount_value": 0,
      "description": "string",
      "applies_to": "string",
      "applies_to_id": "string",
      "valid_from": "string",
      "valid_until": "string",
      "max_uses": 0,
      "image_url": "string",
      "usage_count": 0,
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "customers": [
    {
      "id": "string",
      "name": "string",
      "phone": "string",
      "national_id": "string",
      "notes": "string",
      "image_url": "string",
      "created_at": "string",
      "updated_at": "string",
      "is_credit_allowed": -9007199254740991,
      "credit_limit": 0,
      "current_balance": 0,
      "is_deleted": -9007199254740991
    }
  ],
  "users": [
    {
      "id": "string",
      "branch_id": "string",
      "email": "string",
      "full_name": "string",
      "phone": "string",
      "role": "string",
      "is_active": -9007199254740991,
      "is_deleted": -9007199254740991,
      "last_login_at": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "batches": [
    {
      "id": "string",
      "medicine_id": "string",
      "branch_id": "string",
      "supplier_id": "string",
      "batch_number": "string",
      "expiry_date": "string",
      "manufacturing_date": "string",
      "qty_received": 0,
      "qty_remaining": 0,
      "unit_cost": 0,
      "status": "string",
      "sfda_status": "string",
      "is_deleted": -9007199254740991,
      "created_at": "string"
    }
  ],
  "categories": [
    {
      "slug": "string",
      "name": "string",
      "created_at": "string"
    }
  ]
}

{
  "detail": "string"
}