Skip to main content
POST
/
order
/
link
Create Return Deep Link
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
}
'
{
  "url": "<string>"
}

Authorizations

​
X-Authorization
string
header
required

Body

application/json
​
name
string
required

The name of the order in Shopify.

​
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.

​
gift
boolean

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

Response

Success

​
url
string