Products

The Products API provides endpoints to query products, their activities, and purchases.

Get All Products

GET /products

Retrieves a paginated list of products with filtering options.

Query Parameters

Parameter	Type	Description
page	number	Page number (min: 1, default: 1)
limit	number	Items per page (max: 100, default: 10)
creator	string	Filter by creator address
status	string	Filter by status
coinType	string	Filter by coin type
search	string	Search products (min: 3 chars)
sortBy	string	Sort field (CREATED_AT, NAME, PRICE, etc.)
sortOrder	string	Sort order (ASC/DESC)

Product Status Types

• ACTIVE

• SOLD_OUT

Response

{
	"data": [
		{
			"id": "123e4567-e89b-12d3-a456-426614174000",
			"creator": "0x1234567890abcdef",
			"name": "Product Name",
			"description": "Product description",
			"price": "1000000",
			"coinType": "0x2::sui::SUI",
			"quantity": 100,
			"sold": 50,
			"status": "ACTIVE",
			"createdAt": "2024-01-01T00:00:00Z",
			"updatedAt": "2024-01-01T00:00:00Z"
		}
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Get Product by ID

GET /products/{id}

Retrieves details of a specific product.

Response

{
	"data": {
		// Product object (same as above)
	}
}

Get Product Activities

GET /products/{id}/activities

Retrieves activities for a specific product.

Query Parameters

Parameter	Type	Description
page	number	Page number (min: 1, default: 1)
limit	number	Items per page (max: 100, default: 10)
activityType	string	Filter by activity type
actor	string	Filter by actor address

Activity Types

• CREATED

• UPDATED

• PURCHASED

• QUANTITY_CHANGED

Response

{
	"data": [
		{
			"id": "123e4567-e89b-12d3-a456-426614174000",
			"productId": "123e4567-e89b-12d3-a456-426614174001",
			"activityType": "CREATED",
			"actor": "0x1234567890abcdef",
			"data": {
				"quantity": 5,
				"price": "1000000",
				"reason": "Product purchased"
			},
			"checkpointSequenceNumber": 12345,
			"transactionDigest": "HkPwB75KXX4bQH5Vr6oYpwgwwRSSFJJf6eNFEwAd67N8",
			"createdAt": "2024-01-01T00:00:00Z"
		}
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Get Product Purchases

GET /products/{id}/purchases

Retrieves purchases made for a specific product.

Query Parameters

Parameter	Type	Description
page	number	Page number (min: 1, default: 1)
limit	number	Items per page (max: 100, default: 10)
buyer	string	Filter by buyer address
coinType	string	Filter by coin type
status	string	Filter by status (COMPLETED)
billId	string	Filter by bill ID

Response

{
	"data": [
		{
			"id": "123e4567-e89b-12d3-a456-426614174000",
			"productId": "123e4567-e89b-12d3-a456-426614174001",
			"buyer": "0x1234567890abcdef",
			"quantity": 5,
			"totalPrice": "5000000",
			"status": "COMPLETED",
			"transactionDigest": "HkPwB75KXX4bQH5Vr6oYpwgwwRSSFJJf6eNFEwAd67N8",
			"createdAt": "2024-01-01T00:00:00Z",
			"updatedAt": "2024-01-01T00:00:00Z"
		}
	],
	"meta": {
		"page": 1,
		"limit": 10,
		"total": 100
	}
}

Get Account Product Activities

GET /products/account/{address}/activities

Retrieves product activities for a specific account.

Query Parameters

Same as Get Product Activities

Get Account Product Stats

GET /products/account/{address}/stats

Retrieves product statistics for a specific account.

Response

{
	"data": {
		// Product statistics
	}
}