SureCommerce REST API

Returns a paginated list of active products.

Query parameters

Parameter	Type	Description
search	string	Filter by product name (partial match)
category_id	integer	Filter by category ID
brand_id	integer	Filter by brand ID
sort	string	newest (default) | price_asc | price_desc
per_page	integer	Items per page (default: 15, max: 100)
page	integer	Page number (default: 1)

Example response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "categoryId": 3,
      "brandId": 2,
      "defaultVariantId": 5,
      "minPrice": 1990000,
      "price": 2190000,
      "priceVariant": 2190000,
      "priceOriginal": 2490000,
      "priceOld": 2490000,
      "priceOldVariant": 2490000,
      "hasFlashSale": false,
      "sku": "SP001-RED-M",
      "name": "Product Name",
      "slug": "product-name",
      "image": "https://yourdomain.com/uploads/products/image.jpg",
      "slide": [],
      "status": "published",
      "createdAt": "2026-01-15T10:30:00.000000Z",
      "updatedAt": "2026-06-01T08:00:00.000000Z",
      "category": { "id": 3, "name": "Category Name", "slug": "category-name" },
      "brand": { "id": 2, "name": "Brand Name", "slug": "brand-name" }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 15,
    "total": 73
  }
}

Returns full product data including detail, accessories, technical specifications, and warranty info. Also includes variants and attributes.

Additional fields returned (vs list)

• description — short description
• detail — full HTML description
• technicalSpecifications — array of specification rows
• warrantyDuration, warrantyDurationType, warrantyInfo
• relatedProductIds — array of product IDs
• accessoryIds — array of accessory product IDs
• attributes — product attributes array
• variants — product variants array

Error response (404)

{ "success": false, "message": "Product not found." }

Returns paginated active categories. Supports per_page and page query parameters.

Response fields

id, name, slug, image, icon, description, parentId, order, status, productCount

Returns a single category. Returns 404 if not found or inactive.

Returns paginated active brands. Supports per_page and page query parameters.

Response fields: id, name, slug, logo, website, description, order, status

Returns a single brand. Returns 404 if not found or inactive.

Returns paginated orders. Supports per_page, page, and status filter.

Response fields

id, code, status, shippingFee, couponAmount, totalAmount, note, createdAt, customer (name, phone, email), payment (method, status)

Returns full order detail including line items, shipping info, shipping history, and order history log.

Additional fields (vs list)

• orderDetail — array of line items (product, variant, qty, price, flashSaleName)
• shipping — carrier, tracking code, shipping method, shipping history
• customer — full customer info including VAT details
• orderHistory — array of history events with type, label, data, time

Example orderHistory entry

{
  "id": 10,
  "type": "delivering",
  "label": "Delivering",
  "data": null,
  "adminUserId": 1,
  "time": "2026-06-15T14:20:00.000000Z"
}

Transitions an order through its lifecycle. Only valid transitions are accepted — attempting an out-of-sequence change returns 422 with the list of allowed next statuses.

Status values

Value	Constant	Meaning
1	STATUS_NEW	New — awaiting processing
2	STATUS_RECEIVED	Accepted / Processing
21	STATUS_DELIVERY	Out for delivery
4	STATUS_SUCCESS	Completed successfully
3	STATUS_CANCEL	Cancelled (stock restored)
31	STATUS_CANCEL_USER	Cancel requested by customer

Allowed transitions

Current status	Can transition to	Side effects
1 — NEW	2 — RECEIVED	History logged · Email sent to customer
2 — RECEIVED	21, 4, 3	History logged · Email sent · Stock restored on CANCEL
21 — DELIVERY	4, 3	History logged · Email sent · Stock restored on CANCEL
31 — CANCEL_USER	3, 2	Stock restored on CANCEL · History logged
4 — SUCCESS	—	Terminal state
3 — CANCEL	—	Terminal state

Request body (JSON)

Field	Type	Description
status	integer (required)	Target status value (see table above)
reason	string (optional)	Cancellation reason — only used when transitioning to status 3

Example — accept order (NEW → RECEIVED)

PATCH /api/v1/orders/42/status
Authorization: Bearer {token}
Content-Type: application/json

{ "status": 2 }

Example — cancel order (RECEIVED → CANCEL)

PATCH /api/v1/orders/42/status
Authorization: Bearer {token}
Content-Type: application/json

{ "status": 3, "reason": "Customer requested cancellation" }

Success response 200

{
  "success": true,
  "message": "Order status updated.",
  "data": { "id": 42, "code": "ORD-20260714", "status": 2, ... }
}

Invalid transition response 422

{
  "success": false,
  "message": "Status transition not allowed.",
  "current": 1,
  "allowed": [2]
}

Query parameters

Parameter	Type	Description
code	string (required)	Serial / warranty code to check

Possible responses

// Can be activated (200)
{
  "success": true,
  "data": {
    "can_activate": true,
    "serial": "SC20260001",
    "product_name": "Product Name",
    "sku": "SP001",
    "warranty_period": "12 months"
  }
}

// Already activated (422)
{
  "success": false,
  "message": "Warranty already activated.",
  "data": {
    "already_activated": true,
    "activation_date": "15/01/2026",
    "end_date": "15/01/2027"
  }
}

// Counterfeit detected (422)
{
  "success": false,
  "is_counterfeit": true,
  "risk_level": "high",
  "message": "counterfeit_not_exist"
}

Request body (JSON)

Field	Type	Required	Description
code	string	Yes	Serial / warranty code
name	string	Yes	Customer full name
phone	string	Yes	Customer phone number
email	string	No	Customer email — confirmation sent if provided
address	string	No	Customer address

Success response (200)

{
  "success": true,
  "message": "Warranty activated successfully.",
  "data": {
    "code": "SC20260001",
    "activation_date": "13/07/2026",
    "warranty_end": "13/07/2027"
  }
}

An activation confirmation email is automatically queued if email was provided.

Searches for warranty info. Short numeric values (< 12 chars or starting with 0 / +) are treated as phone numbers and return all matching warranties. Longer strings are treated as serial numbers and return a single warranty.

Request body (JSON)

{ "serial": "0901234567" }     // phone lookup
{ "serial": "SC20260001" }    // serial lookup

Success response — serial lookup (200)

{
  "success": true,
  "data": {
    "serial": "SC20260001",
    "product_name": "Product Name",
    "is_activated": true,
    "activation_date": "13/07/2026 09:00",
    "warranty_time": "12 months",
    "expiration_date": "13/07/2027 09:00",
    "days_remaining": 365,
    "customer": {
      "name": "Nguyen Van A",
      "phone": "0901234567",
      "email": "customer@example.com"
    }
  }
}

Success response — phone lookup (200)

{
  "success": true,
  "data": [
    {
      "serial": "SC20260001",
      "product_name": "Product Name",
      "is_activated": true,
      "activation_date": "13/07/2026 09:00",
      "warranty_time": "12 months",
      "expiration_date": "13/07/2027 09:00",
      "days_remaining": 365,
      "customer": { "name": "Nguyen Van A", "phone": "0901234567", "email": null }
    }
  ]
}

Not found (404)

{ "success": false, "message": "Not found." }