Public API v3
Public API v2 & legacy
Sign Customiser API v3 uses Store-scoped bearer keys and a consistent problem details error contract. Start with thecold-start quickstartto identify your Store, list customisers, and read pricing.
The v2 and legacy request endpoints are deprecated and remain available only for existing integrations. Webhook events are unversioned and continue to apply. Build new request integrations with v3, or use the migration guide to move an existing integration.
Production base URL:https://web.signcustomiser.com. Download theOpenAPI JSONor read the endpoint reference below.
Guides
Use these guides for the decisions that sit around the endpoint contract.
- Authentication and key lifecycle
Create, store, rotate, and revoke Store-scoped API keys safely.
- Cold-start quickstart
Create a scoped key, identify its Store, list customisers, and read pricing.
- Errors and retries
Interpret problem details and recover safely from validation, conflict, and rate-limit responses.
- Versioning and deprecation policy
Understand major versions, compatible additions, breaking changes, and the previous-generation API.
- Migrate from v2 to v3
Move previous-generation requests to v3 without duplicating writes or losing data.
- Canonical, legacy, and UI glossary
Translate canonical API values to legacy spellings and current merchant-admin labels.
Current API, v3
Build new integrations against these endpoints. Required scopes are shown on each reference page and in the generated agent guide.
Analytics
- GETGet an analytics summary
/api/v3/analytics/summary
Customisers
- GETList customisers
/api/v3/customisers - GETGet a customiser
/api/v3/customisers/{customiser_id}
Orders
- GETList orders
/api/v3/orders - POSTCreate an order
/api/v3/orders - POSTQueue an order CSV export
/api/v3/orders/export - GETShow an order
/api/v3/orders/{order_id} - POSTQueue an order email resend
/api/v3/orders/{order_id}/resend
Pricing
- GETGet customiser pricing
/api/v3/customisers/{customiser_id}/pricing - PUTReplace customiser pricing
/api/v3/customisers/{customiser_id}/pricing - PATCHUpdate customiser pricing
/api/v3/customisers/{customiser_id}/pricing - POSTValidate customiser pricing
/api/v3/customisers/{customiser_id}/pricing/validate
Products
- GETList products
/api/v3/products - GETShow a product
/api/v3/products/{product_id} - GETShow product selections
/api/v3/products/{product_id}/selections - POSTSynchronise a product
/api/v3/customisers/{customiser_id}/products
Store
- GETGet the Store subscription
/api/v3/stores/me/subscription
Stores
- GETGet the authenticated store
/api/v3/stores/me
Webhook events
Signed delivery payloads sent from Sign Customiser to your own application, including the product creation callback used by custom integrations.
- WEBHOOKProduct created
product:created - WEBHOOKOrder created
order:created - WEBHOOKForm submitted
form:submitted
Webhook subscriptions
- GETList webhook subscriptions
/api/v3/webhook-subscriptions - POSTCreate a webhook subscription
/api/v3/webhook-subscriptions - GETGet a webhook subscription
/api/v3/webhook-subscriptions/{webhook_id} - PATCHUpdate a webhook subscription
/api/v3/webhook-subscriptions/{webhook_id} - DELETEDelete a webhook subscription
/api/v3/webhook-subscriptions/{webhook_id} - GETList webhook event types
/api/v3/webhook-event-types
v2 & legacy API
The v2 and legacy request endpoints remain visible for existing integrations. Webhook events are unversioned and available in both API pathways. Build all new request integrations with v3. Read the versioning policy before changing an existing integration.
Custom integrations
Backend contract for custom integrations: handle the signed product creation callback, return your own product ID, then submit completed orders into Sign Customiser.
- POSTCreate an orderdeprecated
/api/v2/orders - POSTCreate a legacy orderdeprecated
/api/orders - POSTSync a legacy productdeprecated
/api/customisers/{customiser}/products
Customisers
- GETList customisersdeprecated
/api/v2/customisers - GETGet a customiserdeprecated
/api/v2/customisers/{customiser}
Pricing
- GETGet customiser pricingdeprecated
/api/v2/customisers/{customiser}/pricing - PUTUpdate customiser pricingdeprecated
/api/v2/customisers/{customiser}/pricing
Webhook events
Signed delivery payloads sent from Sign Customiser to your own application, including the product creation callback used by custom integrations.
- WEBHOOKProduct created
product:created - WEBHOOKOrder created
order:created - WEBHOOKForm submitted
form:submitted
Webhooks
Manage webhook subscriptions and inspect the event topics Sign Customiser can deliver to your own systems.
- GETList all webhooksdeprecated
/api/v2/webhooks - POSTCreate a new webhookdeprecated
/api/v2/webhooks - GETGet a single webhookdeprecated
/api/v2/webhooks/{webhook_id} - PUTUpdate a webhookdeprecated
/api/v2/webhooks/{webhook_id} - DELETEDelete a webhookdeprecated
/api/v2/webhooks/{webhook_id} - GETWebhook payload examplesdeprecated
/api/v2/webhook-examples/{topic}