Skip to main content

Create a new product

POST 
/api/v1/sdk/products

This endpoint creates a single new product in VesuvioPay. Use the sync endpoint for bulk operations.

Authentication: Requires Private API Key (sk_*)

Required Fields:

  • name - Product name (max 255 characters)
    • variants - At least one variant with price and externalVariantId
    • externalProductId - Your platform's product identifier

Optional Fields:

  • description, images, metadata, categories, tags
    • Variant options (size, color, etc.)
    • Inventory tracking settings

Use Cases:

  • Creating individual products programmatically
    • Adding new products outside of bulk sync
    • Product creation via webhooks or real-time integrations

Error Scenarios:

  • 400 BAD REQUEST - Missing required fields or invalid data (Error code: INVALID_REQUEST or VALIDATION_ERROR)
    • 409 CONFLICT - Product with same externalProductId already exists (Error code: PRODUCT_ALREADY_EXISTS)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Product created successfully with assigned IDs