Create product

Create a new product in the product catalogue.

Access Control:

• Requires admin permissions with ManageProducts flag

Important Notes:

• Product ID must be unique within the network
• Product URL must be a valid URL
• Price must be positive if provided
• Currency must be a valid ISO 4217 currency code (3 characters)

POST /api/v1/products

Create product

cURL

curl --request POST \
  --url https://apix.us.amity.co/api/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "prod-12345",
  "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"
}
'

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.

Body

application/json

productId · string · required

Unique identifier for the product

Required string length: 1 - 100

Example:

"prod-12345"

productName · string · required

Name of the product

Required string length: 1 - 200

Example:

"Premium Headphones"

productUrl · string<uri> · required

URL to the product page

Example:

"https://example.com/products/premium-headphones"

status · enum<string> · required

Product status

Available options: active, archived

Example:

"active"

price · number

Product price (must be positive)

Required range: x > 0

Example:

99.99

currency · string

ISO 4217 currency code (3 characters)

Required string length: 3

Example:

"USD"

thumbnailUrl · string<uri>

URL to the product thumbnail image

Example:

"https://example.com/images/headphones-thumb.jpg"

thumbnailMode · enum<string>

How the thumbnail should be displayed

Available options: fit, fill

Example:

"fit"

Response

200

application/json

Successful response with product data

status · string

Example:

"success"

data · object

Show child attributes