Create Allowlist Item

Create an allowlist entry.

Required API key scope

• Orders

POST /allowlists

Create Allowlist Item

cURL

curl --request POST \
  --url https://api.loopreturns.com/api/v1/allowlists \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "value": "<string>"
}
'

import requests

url = "https://api.loopreturns.com/api/v1/allowlists"

payload = { "value": "<string>" }
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<string>'})
};

fetch('https://api.loopreturns.com/api/v1/allowlists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loopreturns.com/api/v1/allowlists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loopreturns.com/api/v1/allowlists"

	payload := strings.NewReader("{\n  \"value\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.loopreturns.com/api/v1/allowlists")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/allowlists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": 123,
  "value": "<string>",
  "created_at": "<string>"
}

{
  "errors": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

X-Authorization · string · header · required

Body

application/json

value · string · required

The allowed value. Returns made using this value will override any other return ineligibility.

Example:

"[e-mail]"

type · enum<string> · required

The type of value allowed by this allowlist entry. order is the order number of the allowed order and email is the customer's email address.

Available options: order, email

Response

200

application/json

Success

id · integer

The unique identifier associated with the allowlist entry.

Example:

1

type · enum<string>

The type of value allowed by this allowlist entry. order is the order number of the allowed order and email is the customer's email address.

Available options: order, email

value · string

The allowed value. Returns made using this value will override any other return ineligibility.

Example:

"[e-mail]"

created_at · string | null

The date and time at which the entry was created.

Example:

"2023-06-09 00:00:00"