Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Return Actions

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

Request body

namestring required

The name of the order in the commerce provider (e.g. Shopify).

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

giftboolean

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

Example request

{
  "name": "Shopify Order Name",
  "zip": "43215"
}

Response

Success

urlstring

Example response

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