Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Return Actions

Create Return Deep Link with QR Code

Generate a link to a QR code image file that, when scanned, will take the user directly to their order in Loop so they can initiate a return without requiring them to enter their order information.

The deep link URL is also returned. If type is not included in the request, or is a non-supported format, a png will be returned.

Required API key scope

  • Orders
post/order/qr

Request body

namestring required
zipstring required
giftboolean
type'png' | 'eps' | 'svg'
sizeinteger

Example request

{
  "name": "Shopify Order Name",
  "zip": "43215",
  "type": "png",
  "size": 250
}

Response

Success

qrstring
deeplink_urlstring

Example response

{
  "qr": "https://api.loopreturns.com/api/v1/qr/i/example-uuid-for-qr-image",
  "deeplink_url": "https://test-shop.loopreturns.com/#/link/examp1e-uu1d-h3r3"
}