Skip to main content

Synchronize products from external platforms to VesuvioPay

POST 
/api/v1/sdk/products/sync

This endpoint synchronizes products from your external platform (Shopify, WooCommerce, custom platform) to VesuvioPay in bulk. Supports create and update operations.

Authentication: Requires Private API Key (sk_*)

Request Structure:

  • products (required) - Array of product objects, max 100 per request
    • Each product must have: name, externalProductId, at least one variant
    • Variants must have: externalVariantId, price, inventory tracking settings

Sync Behavior:

  • If externalProductId exists: Product is updated with new data
    • If externalProductId is new: Product is created
    • Partial success supported - some products can succeed while others fail
    • Operation is idempotent - safe to retry with same data
    • Images are downloaded and stored if URLs provided

Use Cases:

  • Initial product catalog import
    • Periodic product synchronization
    • Webhook-triggered product updates
    • Bulk product management operations

Error Scenarios:

  • 400 BAD REQUEST - Invalid product data, missing required fields, or too many products (Error code: INVALID_REQUEST or TOO_MANY_PRODUCTS)
    • 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​

Synchronization completed (check response for individual product results and failures)