Create Return Deep Link

Create a deep link URL. Depending on a shop’s settings, the zip value could be an email, phone number, or postal code. All use the key zip.

Required API key scope

• Orders

POST /order/link

Create Return Deep Link

cURL

curl --request POST \
  --url https://api.loopreturns.com/api/v1/order/link \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "name": "<string>",
  "zip": "<string>",
  "gift": true
}
'

200

{
  "url": "<string>"
}

Authorizations

X-Authorization · string · header · required

Body

application/json

name · string · required

The name of the order in Shopify.

Example:

"Shopify Order Name"

zip · string · required

The order detail used to identify the order. Often the customer's shipping ZIP code, but depending on the merchant's shop settings, could also be the customer's email or phone number.

Example:

"43215"

gift · boolean

Whether or not the return will use Loop's Gift flow. For details, see Gift Returns.

Example:

false

Response

200

application/json

Success

url · string

Example:

"https://test-shop.loopreturns.com/#/link/examp1e-uu1d-h3r3"