Skip to main content

Link product with external product ID

PUT 

/api/v1/sdk/products/:productId/link-external

This endpoint links an existing VesuvioPay product to an external product ID from your platform. Useful when products were created without external IDs.

Authentication: Requires Private API Key (sk_*)

Use Cases:

  • Linking products created manually in VesuvioPay to platform IDs
    • Fixing missing external ID mappings
    • Migrating products between platforms

Error Scenarios:

  • 404 NOT FOUND - Product not found (Error code: PRODUCT_NOT_FOUND)
    • 400 BAD REQUEST - Invalid request or external ID already in use (Error code: INVALID_REQUEST or EXTERNAL_ID_IN_USE)
    • 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 linked successfully to external ID