Verifies if a QuickLink can be consumed by checking validity, status, expiration, usage limits, and permissions.

post

https://example.com/Sites/{siteId}/Quicklinks/Verify/{slug}

Call this endpoint before performing the QuickLink action. If Valid=true, proceed with the action then call Consume.

Possible error codes returned when Valid=false:

LINK_NOT_FOUND: QuickLink slug doesn't exist for this site
LINK_DISABLED: QuickLink status is not Enabled (disabled or deleted)
LINK_EXPIRED: QuickLink has passed its ExpiredUtc date
USAGE_LIMIT_REACHED: QuickLink has reached its usage limit (SingleUse or Limited)
INVALID_TOKEN: Token provided doesn't match any token for this QuickLink
TOKEN_ALREADY_USED: Token has already been consumed (IsUsed=true)
TOKEN_EXPIRED: Token has passed its ExpiredUtc date
SCHEDULED_ORDER_MISMATCH: Token is tied to a different scheduled order
SCHEDULED_ORDER_NOT_FOUND: ScheduledOrderId doesn't exist for this site
CUSTOMER_NOT_FOUND: CustomerId provided doesn't exist for this site

Language

Credentials

Header

Click Try It! to start a request and see the response here!