Docs

Build, install, and operate Velop GiftNote.

Reference notes for merchant setup, WooCommerce integration, custom API use, and message lifecycle behavior.

Onboarding

Create a merchant, generate API key, and connect WooCommerce.

Plugin

Render widget, proxy upload requests, and attach message IDs to orders.

API

Create, confirm, resolve, scan, and cancel GiftNote messages.

Operations

Expiry cleanup, analytics rollups, and QR printing workflow.

Install WooCommerce Plugin

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

  1. Upload or install the plugin
  2. Open WooCommerce > Settings > Velop
  3. Paste the API key from onboarding
  4. Save and test on a product page

Configure Branding

Set store name, logo, brand color, and recipient page CTA.

  1. Open Portal > Branding
  2. Upload logo
  3. Choose primary color
  4. Add optional store CTA

Message Lifecycle

Messages are token-gated, delivered through signed URLs, and expire automatically.

  1. Message starts pending
  2. Upload completes through signed URL
  3. QR is generated on confirm
  4. Media expires after retention window

API Basics

Use the merchant API for custom storefronts or headless commerce flows.

  1. Authenticate with Bearer API key
  2. Create message
  3. Upload media
  4. Confirm and print QR

Endpoint Shape

POST /messages/create
Authorization: Bearer {apiKey}

{
  "orderId": "1042",
  "mediaType": "voice",
  "mimeType": "audio/webm",
  "fileSize": 482331
}
Get an API key