Suppliers & Purchase Orders API

Manage suppliers, create purchase orders, track deliveries, and receive inventory.

GET/admin/suppliers

List all suppliers

Response

{
  "success": true,
  "data": [
    { "id": "sup_01", "name": "SanMar", "contact_email": "orders@sanmar.com", "lead_time_days": 5, "po_count": 24 }
  ]
}
Bearer Token Required
POST/admin/suppliers/purchase-orders

Create a new purchase order

Request Body

{
  "supplier_id": "sup_01",
  "items": [{ "product_id": "prod_123", "quantity": 200, "unit_cost": 4.50 }],
  "expected_delivery": "2026-04-01",
  "notes": "Rush order for spring season"
}

Response

{
  "success": true,
  "data": { "id": "po_2847", "supplier": "SanMar", "status": "draft", "total": 900.00, "created_at": "2026-03-22T12:00:00Z" }
}
Bearer Token Required
PUT/admin/suppliers/purchase-orders/{po_id}/status

Update PO status (draft, submitted, in_transit, received, cancelled)

Request Body

{ "status": "submitted" }
Bearer Token Required

Supplier Integrations API

Connect to supplier systems for automated catalog sync, inventory checks, and order placement.

GET/admin/supplier-integrations

List all configured supplier integrations

Response

{
  "success": true,
  "data": {"integration_id": "integ_01", "provider": "sanmar"}
}
Bearer Token Required
POST/admin/supplier-integrations

Create a new supplier integration

Request Body

{
  "supplier_id": "sup_01",
  "provider": "api_v2",
  "credentials": { "api_key": "sk_...", "base_url": "https://api.supplier.com" }
}
Bearer Token Required
POST/admin/supplier-integrations/{integration_id}/test-credentials

Test connection credentials for a supplier integration

Response

{
  "success": true,
  "data": {"credentials_valid": true}
}
Bearer Token Required
GET/admin/supplier-integrations/providers/available

List available integration provider types

Response

{
  "success": true,
  "data": [{"provider": "sanmar", "name": "SanMar"}]
}
Bearer Token Required

Supplier Catalog API

Sync, review, and approve products from supplier catalogs into your inventory.

GET/admin/supplier-catalog

List items from synced supplier catalogs

Response

{
  "success": true,
  "data": [{"item_id": "cat_001", "supplier": "SanMar"}]
}
Bearer Token Required
POST/admin/supplier-catalog/sync/{integration_id}

Trigger a catalog sync from a supplier integration

Response

{
  "success": true,
  "data": {"sync_id": "sync_01", "status": "in_progress"}
}
Bearer Token Required
POST/admin/supplier-catalog/{item_id}/approve

Approve a catalog item for import into your product list

Response

{
  "success": true,
  "data": {"item_id": "cat_001", "status": "approved"}
}
Bearer Token Required
POST/admin/supplier-catalog/bulk-approve

Bulk approve multiple catalog items at once

Response

{
  "success": true,
  "data": {"approved_count": 5}
}
Bearer Token Required

Supplier Orders API

Submit and track orders placed with integrated suppliers.

GET/admin/supplier-orders

List all supplier orders with filtering by status and date

Bearer Token Required
POST/admin/supplier-orders/submit

Submit a new order to an integrated supplier

Bearer Token Required
POST/admin/supplier-orders/submit-from-po/{po_id}

Submit a supplier order from an existing purchase order

Bearer Token Required
GET/admin/supplier-orders/{order_id}

Get details of a specific supplier order

Bearer Token Required
POST/admin/supplier-orders/{order_id}/refresh-status

Refresh the tracking status of a supplier order from the provider

Bearer Token Required

Shopify Import API

Import products from Shopify CSV exports for migration.

POST/admin/shopify/import/csv

Import products from a Shopify-format CSV file

Bearer Token Required
GET/admin/shopify/import/jobs

List all Shopify import jobs with status

Bearer Token Required
GET/admin/shopify/import/jobs/{job_id}

Get details and progress of a specific import job

Bearer Token Required

Integrations API

Connect and manage third-party integrations — Stripe, Shippo, QuickBooks, and email providers.

Stripe — Payment processing

GET/admin/integrations/stripe/connect

Get current Stripe connection status

Response

{
  "success": true,
  "data": {"stripe_connected": true}
}
Bearer Token Required
POST/admin/integrations/stripe/connect

Connect or update Stripe API keys

Response

{
  "success": true,
  "data": {"stripe_connected": true}
}
Bearer Token Required

Shippo — Shipping & label creation

GET/admin/integrations/shippo/connect

Get current Shippo connection status

Response

{
  "success": true,
  "data": {"shippo_connected": true}
}
Bearer Token Required
POST/admin/integrations/shippo/connect

Connect or update Shippo API token

Response

{
  "success": true,
  "data": {"shippo_connected": true}
}
Bearer Token Required

QuickBooks — Accounting sync

GET/admin/quickbooks/status

Check QuickBooks Online connection status

Response

{
  "success": true,
  "data": {"connected": true, "last_sync": "2026-03-22T08:00:00Z"}
}
Bearer Token Required
GET/admin/quickbooks/connect

Initiate QuickBooks OAuth2 connection flow

Response

{
  "success": true,
  "data": {"qb_connected": true}
}
Bearer Token Required
POST/admin/quickbooks/sync/product/{product_id}

Sync a product to QuickBooks as an inventory item

Response

{
  "success": true,
  "data": {"qb_item_id": "item_123"}
}
Bearer Token Required
POST/admin/quickbooks/sync/order/{order_id}

Sync an order to QuickBooks as a sales receipt or invoice

Response

{
  "success": true,
  "data": {"qb_transaction_id": "txn_456"}
}
Bearer Token Required

Webhooks API

Create and manage webhooks for real-time event notifications.

POST /admin/outgoing-webhooks

Create a webhook subscription

Request Body

{
  "url": "https://example.com/webhooks",
  "events": ["order.created", "order.updated", "product.low_stock"],
  "active": true
}

Response

{
  "success": true,
  "data": {
    "webhook_id": "wh_001",
    "url": "https://example.com/webhooks",
    "events": ["order.created", "order.updated", "product.low_stock"],
    "created_at": "2026-03-20T10:00:00Z"
  }
}
Bearer Token Required
GET /admin/outgoing-webhooks/{id}/deliveries

Get delivery logs for a webhook

Response

{
  "success": true,
  "data": [
    {
      "delivery_id": "del_001",
      "event": "order.created",
      "status": "success",
      "status_code": 200,
      "delivered_at": "2026-03-20T10:05:00Z"
    }
  ]
}
Bearer Token Required
POST /admin/outgoing-webhooks/{id}/test

Send a test webhook event

Response

{
  "success": true,
  "data": {
    "test_sent": true,
    "status_code": 200,
    "response_time": 145
  }
}
Bearer Token Required

Import / Export API

CSV import with preview and validation, bulk operations, and Shopify migration.

GET/admin/import/products/csv/template

Download the CSV import template with all supported columns

Response

{
  "success": true,
  "data": "CSV template file content"
}
Bearer Token Required
POST/admin/import/products/csv/preview

Upload a CSV and preview what will be imported (dry run)

Request

Content-Type: multipart/form-data
file: products.csv

Response

{
  "success": true,
  "data": { "total_rows": 150, "valid": 148, "errors": 2, "preview": [...] }
}
Bearer Token Required
POST/admin/shopify/import/csv

Import products from a Shopify CSV export

Response

{
  "success": true,
  "data": {"products_imported": 42, "skipped": 2}
}
Bearer Token Required