QPqpilot
QuickLinks

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}

Request

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

scheduledOrderIdinteger required
customerIdinteger nullable
ipAddressstring nullable
userAgentstring nullable
isLoggedInboolean

Response

Returns verification result (may be valid or invalid with error code)

validboolean
errorCodestring nullable
errorMessagestring nullable
quickLinkIdinteger nullable
actionType'Resume' | 'Pause' | 'ProcessNow' | 'Reactivate'
requiresLoginboolean nullable
requiresConfirmationboolean nullable
scheduledOrderIdinteger nullable
customerIdinteger nullable
usageLimitType'SingleUse' | 'LimitedUse' | 'Unlimited'
maxUsesinteger nullable
expiredUtcstring date-time nullable
orderCustomizedNamestring nullable
customLogoUrlstring nullable
customDomainUrlstring nullable
proxyPathstring nullable
customStyleSheetUrlstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.