Build, install, and operate Velop GiftNote.

Install WooCommerce Plugin

Install Velop GiftNote, paste your API key, and choose where the GiftNote widget appears on your product pages.

1. Download the Velop GiftNote ZIP from Portal → Onboarding → Download plugin.
2. In WordPress admin go to Plugins → Add New → Upload Plugin, choose the ZIP, then click Install Now and Activate.
3. Open WooCommerce → Settings → Velop tab.
4. Paste your API key (visible on the Onboarding page) into the API Key field and save.
5. Optionally set Widget Placement to Product page, Checkout, or both.
6. Open a product page in your store to confirm the GiftNote add-on appears.
7. Return to Portal → Onboarding and click Mark done on the plugin step.

Configure Branding

Set your store name, logo, brand colour, and a call-to-action link on the recipient viewer page.

1. Open Portal → Branding.
2. Upload your store logo — PNG, SVG, or JPG up to 2 MB. The logo appears in the viewer header.
3. Pick a primary brand colour with the colour picker. This sets the viewer background and button colour.
4. Enter a CTA text (e.g. Shop the collection) and the destination URL.
5. Click Save changes. Your branding is live on all viewer pages immediately — no redeploy needed.
6. Preview the branded viewer in the Live preview panel at the bottom of the Branding page.

Message Lifecycle

Messages are token-gated, delivered through signed storage URLs, and expire automatically based on your retention window.

1. A new message starts in Pending state when the order is placed.
2. The customer records or uploads media — the upload goes directly to secure storage via a short-lived signed URL.
3. On confirmation the message moves to Active and a unique QR token is generated.
4. The QR code is printed on the packing slip or gift card and ships with the order.
5. The recipient scans the QR, which opens the branded viewer and plays the message.
6. Media expires automatically after the retention window (14, 30, or 60 days based on your settings).

API Basics

Use the merchant REST API for custom storefronts, headless commerce, or direct integrations.

1. Find your API key on Portal → Onboarding. Pass it as a Bearer token: Authorization: Bearer vlp_live_...
2. POST /messages/create with orderId, mediaType (voice/video/upload), mimeType, and fileSize.
3. Upload media directly to the signed uploadUrl returned by /create — no server proxy needed.
4. POST /messages/:id/confirm to activate the message and receive the QR viewer URL.
5. Use the viewerUrl or token to generate a printable QR code for the packing slip.
6. POST /messages/:id/cancel to void a message before the order ships.

Endpoint Shape

POST /messages/create
Authorization: Bearer {apiKey}

{
  "orderId": "1042",
  "mediaType": "voice",
  "mimeType": "audio/webm",
  "fileSize": 482331
}