Product API Documentation

Product Management

This section details the endpoints for managing product information within our system. You can retrieve, create, update, and delete products using these APIs.

Retrieves a list of all available products.

Query Parameters:

• limit (integer, optional): Maximum number of products to return.
• offset (integer, optional): Number of products to skip.
• category (string, optional): Filter products by category ID.

Response Example:

[
  {
    "id": "prod_1a2b3c",
    "name": "Quantum Leap Smartwatch",
    "description": "Track your fitness and stay connected with the latest smartwatch technology.",
    "price": 199.99,
    "currency": "USD",
    "category": "electronics",
    "in_stock": 50,
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z"
  },
  {
    "id": "prod_4d5e6f",
    "name": "Astro Camping Tent",
    "description": "Durable and spacious tent for your next outdoor adventure.",
    "price": 89.50,
    "currency": "USD",
    "category": "outdoors",
    "in_stock": 120,
    "created_at": "2023-10-26T14:30:00Z",
    "updated_at": "2023-10-26T14:30:00Z"
  }
]

Creates a new product.

Request Body:

{
  "name": "Galactic Coffee Maker",
  "description": "Brew the perfect cup with our advanced coffee maker.",
  "price": 75.00,
  "currency": "USD",
  "category": "kitchenware",
  "in_stock": 200
}

Response Example:

{
  "id": "prod_7g8h9i",
  "name": "Galactic Coffee Maker",
  "description": "Brew the perfect cup with our advanced coffee maker.",
  "price": 75.00,
  "currency": "USD",
  "category": "kitchenware",
  "in_stock": 200,
  "created_at": "2023-10-27T11:00:00Z",
  "updated_at": "2023-10-27T11:00:00Z"
}

Retrieves details for a specific product by its ID.

Path Parameters:

• productId (string, required): The unique identifier of the product.

Response Example:

{
  "id": "prod_1a2b3c",
  "name": "Quantum Leap Smartwatch",
  "description": "Track your fitness and stay connected with the latest smartwatch technology.",
  "price": 199.99,
  "currency": "USD",
  "category": "electronics",
  "in_stock": 50,
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}

Updates an existing product.

Path Parameters:

• productId (string, required): The unique identifier of the product to update.

Request Body:

{
  "price": 209.99,
  "in_stock": 45
}

Response Example:

{
  "id": "prod_1a2b3c",
  "name": "Quantum Leap Smartwatch",
  "description": "Track your fitness and stay connected with the latest smartwatch technology.",
  "price": 209.99,
  "currency": "USD",
  "category": "electronics",
  "in_stock": 45,
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T11:30:00Z"
}

Deletes a product by its ID.

Path Parameters:

• productId (string, required): The unique identifier of the product to delete.

Response Example:

{
  "message": "Product prod_1a2b3c deleted successfully."
}