Skip to main content
API docs by Redocly

E-Commerce Engine API (1.0.0)

Download OpenAPI specification:Download

Comprehensive API specification for Axiolon Labs E-Commerce Engine. All responses wrap payloads in a standardized success/error envelope.

Authentication

Register a new user

Registers a new customer or administrator account. Defaults to "customer" role.

Request Body schema: application/json
required
email
required
string <email>
password
required
string
role
string
Default: "customer"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string",
  • "role": "customer"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Login and obtain session tokens

Authenticates user credentials and returns access & refresh tokens.

Request Body schema: application/json
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Logout user session

Revokes the provided refresh token.

Request Body schema: application/json
required
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Refresh access token

Obtains a new session (access & refresh token) using a valid, active refresh token.

Request Body schema: application/json
required
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Request password reset token

Initiates password reset flow. Returns reset token directly in response for local/testing.

Request Body schema: application/json
required
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Confirm password reset

Applies the new password using the generated reset token.

Request Body schema: application/json
required
token
required
string
new_password
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Catalog

List all products

Retrieves products catalog with optional filters.

query Parameters
category_id
string
price_min
number
price_max
number
attributes
string

Comma-separated query of size:XL,color:blue

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Create a product

Creates a new product with variants.

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string
description
string
category_id
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category_id": "string",
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get product details

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a product

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
description
string
category_id
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category_id": "string",
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a product

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List categories

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Create a category

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string
slug
string
parent_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "parent_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get category details

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a category

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
slug
string
parent_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "parent_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a category

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Search products

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Get presigned upload URL for product image

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Register uploaded product image

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete product image

Authorizations:
BearerAuth
path Parameters
id
required
string
imageId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Set image as primary product image

Authorizations:
BearerAuth
path Parameters
id
required
string
imageId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get product variants

path Parameters
id
required
string

Responses

Add product variant

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Update product variant

Authorizations:
BearerAuth
path Parameters
id
required
string
variantId
required
string

Responses

Delete product variant

Authorizations:
BearerAuth
path Parameters
id
required
string
variantId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Apply product discount

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Remove product discount

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Bulk create products

Authorizations:
BearerAuth

Responses

Bulk update products

Authorizations:
BearerAuth

Responses

Bulk delete products

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Reviews

Get product reviews

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Submit a review

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
rating
required
integer [ 1 .. 5 ]
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "rating": 1,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get product average rating summary

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update product review

Authorizations:
BearerAuth
path Parameters
id
required
string
reviewId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete product review

Authorizations:
BearerAuth
path Parameters
id
required
string
reviewId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Reply to product review

Authorizations:
BearerAuth
path Parameters
id
required
string
reviewId
required
string

Responses

Shopping Cart

Retrieve the current customer cart

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Add/update item in cart

Authorizations:
BearerAuth
Request Body schema: application/json
required
variant_id
required
string
quantity
required
integer
price
number

Responses

Request samples

Content type
application/json
{
  • "variant_id": "string",
  • "quantity": 0,
  • "price": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Clear cart items

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get cart item count

Authorizations:
BearerAuth

Responses

Update cart item quantity/price

Authorizations:
BearerAuth
path Parameters
variantId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Remove cart item

Authorizations:
BearerAuth
path Parameters
variantId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Merge carts

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Orders

Create order from items

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
Array of objects (OrderItemRequest)
Array
variant_id
required
string
quantity
required
integer
price
required
number

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List authenticated user's orders

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get customer order by ID

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Place order as guest

Request Body schema: application/json
required
required
object
required
Array of objects (OrderItemRequest)

Responses

Request samples

Content type
application/json
{
  • "guest_info": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Cancel order

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Inventory

Check stock level of a variant

path Parameters
variantID
required
string
query Parameters
location_id
string
Default: "default"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete stock item record

Authorizations:
BearerAuth
path Parameters
variantID
required
string
query Parameters
location_id
string
Default: "default"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List inventory levels

Authorizations:
BearerAuth
query Parameters
variant_id
string
location_id
string
status
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get inventory alerts

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update stock quantity

Authorizations:
BearerAuth
Request Body schema: application/json
required
variant_id
required
string
location_id
string
Default: "default"
quantity
required
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "variant_id": "string",
  • "location_id": "default",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Configure stock thresholds/backorders

Authorizations:
BearerAuth
Request Body schema: application/json
required
variant_id
required
string
location_id
string
quantity
integer
low_stock_threshold
integer
allow_backorders
boolean
backorder_limit
integer

Responses

Request samples

Content type
application/json
{
  • "variant_id": "string",
  • "location_id": "string",
  • "quantity": 0,
  • "low_stock_threshold": 0,
  • "allow_backorders": true,
  • "backorder_limit": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Transfer inventory stock

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Sync inventory stock

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Reserve inventory stock

Authorizations:
BearerAuth
path Parameters
variantID
required
string

Responses

Release inventory reservation

Authorizations:
BearerAuth
path Parameters
variantID
required
string
reservationID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Bulk update inventory stock

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Adjust stock level

Authorizations:
BearerAuth
path Parameters
variantID
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Retrieve low stock inventory items

Authorizations:
BearerAuth

Responses

Export stock records

Authorizations:
BearerAuth

Responses

Admin

Get admin dashboard stats

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List all system orders

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get any order by ID

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Transition order status

Authorizations:
BearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
action
required
string

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List all shipments

Authorizations:
BearerAuth

Responses

Create shipment record

Authorizations:
BearerAuth

Responses

Update shipment status

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Delete shipment record

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List system payments

Authorizations:
BearerAuth

Responses

Refund payment

Authorizations:
BearerAuth

Responses

Get system payment details by ID

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Notifications

Send notification to user

Authorizations:
BearerAuth
Request Body schema: application/json
required
user_id
required
string
type
required
string
message
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "type": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Shipping

Calculate shipping rates

Responses

Track shipment status

path Parameters
tracking_number
required
string

Responses

Get order shipment details

Authorizations:
BearerAuth
path Parameters
order_id
required
string

Responses

List all shipments

Authorizations:
BearerAuth

Responses

Create shipment record

Authorizations:
BearerAuth

Responses

Update shipment status

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Delete shipment record

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Payments

Payment provider webhook callback

path Parameters
provider
required
string

Responses

Create checkout payment intent

Authorizations:
BearerAuth

Responses

List customer payments

Authorizations:
BearerAuth

Responses

Get payment details by order ID

Authorizations:
BearerAuth
path Parameters
orderID
required
string

Responses

List system payments

Authorizations:
BearerAuth

Responses

Refund payment

Authorizations:
BearerAuth

Responses

Get system payment details by ID

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses