Skip to main content
POST
/
blocklists
Create Blocklist Item
curl --request POST \
  --url https://api.loopreturns.com/api/v1/blocklists \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '{
  "value": "example@example.com",
  "type": "order",
  "secondary_value": "example.2@example.com"
}'
{
  "id": 1,
  "type": "order",
  "value": "example@example.com",
  "secondary_value": "example.2@example.com"
}

Authorizations

​
X-Authorization
string
header
required

Body

application/json
​
value
string
required

The blocked value. Items purchased using this value will be ineligible for return.

Examples:

"example@example.com"

​
type
enum<string>
required

The type of value blocked by this blocklist entry. order is the order number of the blocked order, email is the blocked customer's email address, product is the variant ID of the blocked product, and product_tag disables returns for all products with that tag.

Available options:
order,
email,
product,
product_tag
​
secondary_value
string

An additional blocked value associated with this entry. Items purchased using this value will also be ineligible for return.

Examples:

"example.2@example.com"

Response

Success

​
id
integer

The unique identifier associated with the blocklist entry.

Examples:

1

​
type
enum<string>

The type of value blocked by this blocklist entry. order is the order number of the blocked order, email is the blocked customer's email address, product is the variant ID of the blocked product, and product_tag disables returns for all products with that tag.

Available options:
order,
email,
product,
product_tag
​
value
string

The blocked value. Items purchased using this value will be ineligible for return.

Examples:

"example@example.com"

​
secondary_value
string

An additional blocked value associated with this entry. Items purchased using this value will also be ineligible for return.

Examples:

"example.2@example.com"