Skip to main content
POST
/
v1
/
terminal
/
offers
Create a terminal offer
curl --request POST \
  --url https://api.yorlet.com/v1/terminal/offers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": "<string>",
  "name": "<string>",
  "discount": {
    "amount_off": 1,
    "min_spend": 1,
    "percent_off": 50
  },
  "expires_at": 123,
  "max_redemptions": 123,
  "terms_of_service": {
    "text": "<string>"
  }
}
'
import requests

url = "https://api.yorlet.com/v1/terminal/offers"

payload = {
    "location": "<string>",
    "name": "<string>",
    "discount": {
        "amount_off": 1,
        "min_spend": 1,
        "percent_off": 50
    },
    "expires_at": 123,
    "max_redemptions": 123,
    "terms_of_service": { "text": "<string>" }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    location: '<string>',
    name: '<string>',
    discount: {amount_off: 1, min_spend: 1, percent_off: 50},
    expires_at: 123,
    max_redemptions: 123,
    terms_of_service: {text: '<string>'}
  })
};

fetch('https://api.yorlet.com/v1/terminal/offers', 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.yorlet.com/v1/terminal/offers",
  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([
    'location' => '<string>',
    'name' => '<string>',
    'discount' => [
        'amount_off' => 1,
        'min_spend' => 1,
        'percent_off' => 50
    ],
    'expires_at' => 123,
    'max_redemptions' => 123,
    'terms_of_service' => [
        'text' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.yorlet.com/v1/terminal/offers"

	payload := strings.NewReader("{\n  \"location\": \"<string>\",\n  \"name\": \"<string>\",\n  \"discount\": {\n    \"amount_off\": 1,\n    \"min_spend\": 1,\n    \"percent_off\": 50\n  },\n  \"expires_at\": 123,\n  \"max_redemptions\": 123,\n  \"terms_of_service\": {\n    \"text\": \"<string>\"\n  }\n}")

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

	req.Header.Add("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.yorlet.com/v1/terminal/offers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"location\": \"<string>\",\n  \"name\": \"<string>\",\n  \"discount\": {\n    \"amount_off\": 1,\n    \"min_spend\": 1,\n    \"percent_off\": 50\n  },\n  \"expires_at\": 123,\n  \"max_redemptions\": 123,\n  \"terms_of_service\": {\n    \"text\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/terminal/offers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"location\": \"<string>\",\n  \"name\": \"<string>\",\n  \"discount\": {\n    \"amount_off\": 1,\n    \"min_spend\": 1,\n    \"percent_off\": 50\n  },\n  \"expires_at\": 123,\n  \"max_redemptions\": 123,\n  \"terms_of_service\": {\n    \"text\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created": 123,
  "object": "terminal.offer",
  "complimentary_item": {},
  "discount": {
    "amount_off": 1,
    "min_spend": 1,
    "percent_off": 50
  },
  "expires_at": 123,
  "location": "<string>",
  "max_redemptions": 123,
  "name": "<string>",
  "terms_of_service": {
    "text": "<string>"
  },
  "trigger": {
    "type": "move_in"
  },
  "account": "<string>",
  "deleted": false
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
location
string
required

The ID of the location the offer applies to.

Minimum string length: 1
name
string
required

A name for the offer.

Minimum string length: 1
type
enum<string>
required

The type of the offer.

Available options:
complimentary_item,
discount
complimentary_item
object

Details about the complimentary item offered. Required when type is complimentary_item.

discount
object

Details about the discount offered. Required when type is discount.

expires_at
integer

The date and time at which the offer expires.

max_redemptions
number

The maximum number of times the offer can be redeemed.

trigger
object

A trigger that automatically grants the offer when an event occurs.

terms_of_service
object

The terms of service that apply to the offer.

Response

200 - application/json

Create a terminal offer

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
terminal.offer
complimentary_item
object | null
required

Details about the complimentary item offered. Required when type is complimentary_item.

discount
object | null
required

Details about the discount offered. Required when type is discount.

expires_at
integer | null
required

The date and time at which the offer expires.

location
required

The location the offer applies to.

max_redemptions
number | null
required

The maximum number of times the offer can be redeemed.

name
string
required

A name for the offer.

Minimum string length: 1
status
enum<string>
required

The status of the offer.

Available options:
active,
inactive,
expired
terms_of_service
object
required

The terms of service that apply to the offer.

trigger
object | null
required

A trigger that automatically grants the offer when an event occurs.

type
enum<string>
required

The type of the offer.

Available options:
complimentary_item,
discount
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.