Shopify B2B API Documentation

Authentication options for protected endpoints:

All responses are JSON. Money values are returned as strings.

GET /api/v1/health

Description: Service health status and version information.

Auth: Optional

Example call:

curl -X GET "/api/v1/health"
GET /api/v1/products

Description: List products with B2B pricing and image fields.

Auth: Required (Bearer or api_key query)

Query parameters:

  • cursor — Pagination cursor
  • limit — Items per page (default 50, max 250)
  • sku — Filter by partial SKU
  • vendor — Filter by vendor/brand
  • status — active|draft|archived (default active)
  • updated_since — ISO8601 datetime filter

Example call:

curl -X GET "/api/v1/products?limit=50&status=active&api_key=b2b_your_key_here"
GET /api/v1/products/{sku}

Description: Get a single SKU with parent product info, prices, and images.

Auth: Required (Bearer or api_key query)

Example call:

curl -X GET "/api/v1/products/REF-001-BLK?api_key=b2b_your_key_here"
GET /api/v1/stock

Description: Get stock levels across locations.

Auth: Required (Bearer or api_key query)

Query parameters:

  • sku — Comma-separated SKUs
  • location_id — Filter by location id
  • low_stock — Only rows where available <= value

Example call:

curl -X GET "/api/v1/stock?sku=REF-001-BLK,REF-002-RED&api_key=b2b_your_key_here"
GET /api/v1/stock/{sku}

Description: Get stock for one SKU across all locations.

Auth: Required (Bearer or api_key query)

Example call:

curl -X GET "/api/v1/stock/REF-001-BLK?api_key=b2b_your_key_here"
GET /api/v1/locations

Description: List all active Shopify locations.

Auth: Required (Bearer or api_key query)

Example call:

curl -X GET "/api/v1/locations?api_key=b2b_your_key_here"