Actualizar
curl --request PATCH \
--url https://sandbox.api.riqra.com/promotions/{promotionId} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "<string>",
"usageLimit": 2,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"rules": [
{
"type": "<string>",
"configuration": {
"value": 1
}
}
],
"actions": [
{
"configuraion": {
"property": "<string>",
"values": [
"<string>"
],
"amount": 123,
"applyRepetitions": true,
"each": 123
}
}
]
}
'import requests
url = "https://sandbox.api.riqra.com/promotions/{promotionId}"
payload = {
"name": "<string>",
"usageLimit": 2,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"rules": [
{
"type": "<string>",
"configuration": { "value": 1 }
}
],
"actions": [{ "configuraion": {
"property": "<string>",
"values": ["<string>"],
"amount": 123,
"applyRepetitions": True,
"each": 123
} }]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
usageLimit: 2,
startDate: '2023-11-07T05:31:56Z',
expirationDate: '2023-11-07T05:31:56Z',
rules: [{type: '<string>', configuration: {value: 1}}],
actions: [
{
configuraion: {
property: '<string>',
values: ['<string>'],
amount: 123,
applyRepetitions: true,
each: 123
}
}
]
})
};
fetch('https://sandbox.api.riqra.com/promotions/{promotionId}', 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://sandbox.api.riqra.com/promotions/{promotionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'usageLimit' => 2,
'startDate' => '2023-11-07T05:31:56Z',
'expirationDate' => '2023-11-07T05:31:56Z',
'rules' => [
[
'type' => '<string>',
'configuration' => [
'value' => 1
]
]
],
'actions' => [
[
'configuraion' => [
'property' => '<string>',
'values' => [
'<string>'
],
'amount' => 123,
'applyRepetitions' => true,
'each' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <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://sandbox.api.riqra.com/promotions/{promotionId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api-key", "<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.patch("https://sandbox.api.riqra.com/promotions/{promotionId}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.riqra.com/promotions/{promotionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"message": "<string>",
"code": 123
}
]
}{
"errors": [
{
"message": "<string>",
"code": 123
}
]
}Promociones
Actualizar
Actualiza una promoción.
PATCH
/
promotions
/
{promotionId}
Actualizar
curl --request PATCH \
--url https://sandbox.api.riqra.com/promotions/{promotionId} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "<string>",
"usageLimit": 2,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"rules": [
{
"type": "<string>",
"configuration": {
"value": 1
}
}
],
"actions": [
{
"configuraion": {
"property": "<string>",
"values": [
"<string>"
],
"amount": 123,
"applyRepetitions": true,
"each": 123
}
}
]
}
'import requests
url = "https://sandbox.api.riqra.com/promotions/{promotionId}"
payload = {
"name": "<string>",
"usageLimit": 2,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"rules": [
{
"type": "<string>",
"configuration": { "value": 1 }
}
],
"actions": [{ "configuraion": {
"property": "<string>",
"values": ["<string>"],
"amount": 123,
"applyRepetitions": True,
"each": 123
} }]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
usageLimit: 2,
startDate: '2023-11-07T05:31:56Z',
expirationDate: '2023-11-07T05:31:56Z',
rules: [{type: '<string>', configuration: {value: 1}}],
actions: [
{
configuraion: {
property: '<string>',
values: ['<string>'],
amount: 123,
applyRepetitions: true,
each: 123
}
}
]
})
};
fetch('https://sandbox.api.riqra.com/promotions/{promotionId}', 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://sandbox.api.riqra.com/promotions/{promotionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'usageLimit' => 2,
'startDate' => '2023-11-07T05:31:56Z',
'expirationDate' => '2023-11-07T05:31:56Z',
'rules' => [
[
'type' => '<string>',
'configuration' => [
'value' => 1
]
]
],
'actions' => [
[
'configuraion' => [
'property' => '<string>',
'values' => [
'<string>'
],
'amount' => 123,
'applyRepetitions' => true,
'each' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <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://sandbox.api.riqra.com/promotions/{promotionId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api-key", "<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.patch("https://sandbox.api.riqra.com/promotions/{promotionId}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.riqra.com/promotions/{promotionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"usageLimit\": 2,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"expirationDate\": \"2023-11-07T05:31:56Z\",\n \"rules\": [\n {\n \"type\": \"<string>\",\n \"configuration\": {\n \"value\": 1\n }\n }\n ],\n \"actions\": [\n {\n \"configuraion\": {\n \"property\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"amount\": 123,\n \"applyRepetitions\": true,\n \"each\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"message": "<string>",
"code": 123
}
]
}{
"errors": [
{
"message": "<string>",
"code": 123
}
]
}Autorizaciones
Todas las llamadas al API tienen que contener este header junto a la clave para poder autenticar y autorizar al cliente.
Parámetros de ruta
Cuerpo
application/json
Nombre de la promoción que se mostrará en el checkout.
Maximum string length:
60Máximo número de veces que se puede utilizar/canjear una promoción.
Rango requerido:
x >= 1Minimum array length:
1Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Respuesta
No Content
⌘I