API Reference
Fetch subscription products list
GET/v1/subscriptions/productsFetch list of all products defined in the service by the Merchant. You can fetch any number of products from the list. The product description should be complaint with the scheme shown below.
Request
Query Params
itemsPerPage
string
optional
Limit of results
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Page of results
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
string
optional
Direction of order
Allowed values:
ascdesc
Default:
asc
sortBy
string
optional
column sorting
Allowed values:
idmerchantIdshopIdterminalIdcreatedAtupdatedAt
Default:
createdAt
Header Params
request-id
string
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
Request samples
Responses
OK(200)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array[object (Product) {12}]
required
url
string
optional
Match pattern:
^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
id
string <uuid>
required
merchantId
string
required
shopId
string
required
terminalId
string
required
name
string
required
>= 1 characters<= 125 characters
description
string
required
>= 1 characters<= 500 characters
type
string
required
Allowed values:
productservice
status
string
required
Allowed values:
verifiedblockedpending
createdAt
required
updatedAt
required
deletedAt
string
optional
Match pattern:
d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?
meta
object
Meta
itemsPerPage
string
optional
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
string
optional
Allowed values:
ascdesc
Default:
asc
sortBy
string
optional
Allowed value:
createdAt
Default:
createdAt
Example
{
"data": [
{
"url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchantId": "string",
"shopId": "string",
"terminalId": "string",
"name": "string",
"description": "string",
"type": "product",
"status": "verified",
"createdAt": "2019-08-24",
"updatedAt": "2019-08-24",
"deletedAt": "string"
}
],
"meta": {
"itemsPerPage": "10",
"page": "1",
"direction": "asc",
"sortBy": "createdAt"
}
}Modified at 4 days ago