Skip to main content
GET
/
api
/
v1
/
products
Query products
curl --request GET \
  --url https://apix.us.amity.co/api/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "_id": "64a1b2c3d4e5f6g7h8i9j0k1",
      "productId": "prod-12345",
      "networkId": "network-abc123",
      "productName": "Premium Headphones",
      "productUrl": "https://example.com/products/premium-headphones",
      "status": "active",
      "price": 99.99,
      "currency": "USD",
      "thumbnailUrl": "https://example.com/images/headphones-thumb.jpg",
      "thumbnailMode": "fit",
      "importSource": "manual",
      "createdBy": "user-xyz789",
      "updatedBy": "user-xyz789",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "isDeleted": false
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
isActive
boolean

Filter by active status

​
isDeleted
boolean

Filter by deleted status

​
sortBy
enum<string>

Field to sort by

Available options:
createdAt,
updatedAt,
productName
​
sortOrder
enum<string>

Sort order

Available options:
asc,
desc
​
options[limit]
integer
default:20

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
​
options[token]
string

Pagination token for fetching next page

Maximum string length: 1000

Response

Successful response with list of products

​
status
string
Example:

"success"

​
data
object[]
​
paging
object