Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Blocklist

Create Blocklist Item

Create a blocklist entry.

Required API key scope

  • Orders
post/blocklists

Request body

valuestring required

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

type'order' | 'email' | 'product' | 'product_tag' 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.

secondary_valuestring

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

Example request

{
  "value": "example@example.com",
  "secondary_value": "example.2@example.com"
}

Response

Success

idinteger

The unique identifier associated with the blocklist entry.

type'order' | 'email' | 'product' | 'product_tag'

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.

valuestring

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

secondary_valuestring nullable

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

created_atstring date-time nullable

The date and time at which the entry was created.

Example response

{
  "id": 1,
  "value": "example@example.com",
  "secondary_value": "example.2@example.com",
  "created_at": "2023-06-09 00:00:00"
}