Skip to main content
GET
/
product
cURL
curl --request GET \
  --url https://uat-api.clinkbill.com/api/product \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "total": 123,
  "rows": [
    {
      "productId": "<string>",
      "name": "<string>",
      "active": true,
      "description": "<string>",
      "defaultPrice": "<string>",
      "image": "<string>",
      "taxCategory": "digital_goods_or_service",
      "createTime": 123,
      "updateTime": 123
    }
  ],
  "code": 123,
  "msg": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

X-Timestamp
string
header
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Query Parameters

pageNum
integer<int32>
required

Current page number,and the default is 1

pageSize
integer<int32>
required

Size of the query results per page,pageSize can range between 1 and 100

Response

Product details retrieved successfully

Table Paging Data Object

total
integer<int64>

Total number of records

rows
object[]

List of data

code
integer<int32>

Response status code, 200 when success

msg
string

Brief description of what happened, 'success' when happy case