Get products by IDs

Retrieve multiple products by their product IDs.

Access Control:

• All authenticated users can retrieve products

Important Notes:

• Accepts 1-100 product IDs per request
• Returns products in the same order as the input IDs
• Product feature must be enabled in network settings

GET /api/v1/products/list

Get products by IDs

cURL

curl --request GET \
  --url https://apix.us.amity.co/api/v1/products/list \
  --header 'Authorization: Bearer <token>'

200

{
  "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
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

productIds · string[] · required

Array of product IDs to retrieve (1-100 items)

Required array length: 1 - 100 elements

Required string length: 1 - 100

Response

200

application/json

Successful response with list of products by IDs

status · string

Example:

"success"

data · object[]

Show child attributes