Skip to main content
Version: 1.0.1 (Latest)

ADMIN API

The Shoplazza Admin API lets you build apps and integrations that extend Shoplazza functionality.

Overview​

The Admin API provides programmatic access to:

  • Products and inventory
  • Orders and fulfillment
  • Customers and marketing
  • Store settings and configuration

API Endpoints​

Products​

Manage your product catalog:

  • GET /admin/api/2024-01/products.json - List products
  • GET /admin/api/2024-01/products/{id}.json - Get product
  • POST /admin/api/2024-01/products.json - Create product
  • PUT /admin/api/2024-01/products/{id}.json - Update product
  • DELETE /admin/api/2024-01/products/{id}.json - Delete product

Orders​

Access and manage orders:

  • GET /admin/api/2024-01/orders.json - List orders
  • GET /admin/api/2024-01/orders/{id}.json - Get order
  • POST /admin/api/2024-01/orders.json - Create order
  • PUT /admin/api/2024-01/orders/{id}.json - Update order

Customers​

Manage customer data:

  • GET /admin/api/2024-01/customers.json - List customers
  • GET /admin/api/2024-01/customers/{id}.json - Get customer
  • POST /admin/api/2024-01/customers.json - Create customer
  • PUT /admin/api/2024-01/customers/{id}.json - Update customer

Inventory​

Track inventory levels:

  • GET /admin/api/2024-01/inventory_levels.json - List inventory
  • POST /admin/api/2024-01/inventory_levels/set.json - Set inventory
  • POST /admin/api/2024-01/inventory_levels/adjust.json - Adjust inventory

Next Steps​

Explore specific API resources in the detailed documentation.