v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBQuickLinks
Verifies if a QuickLink can be consumed by checking validity, status, expiration, usage limits, and permissions.
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
post/Sites/{siteId}/Quicklinks/Verify/{slug}
Path parameters
siteIdinteger required
The unique identifier of the site
slugstring required
The unique slug of the QuickLink
Query parameters
tokenstring
Optional token for single-use QuickLinks
Request body
Response
Returns verification result (may be valid or invalid with error code)