Skip to main content
POST
/
schedules
/
adjustments
Create a schedule adjustment
curl --request POST \
  --url https://api.juo.io/admin/v1/schedules/adjustments \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "customerId": "<string>",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 1
    }
  },
  "action": {
    "type": "SKIP_ORDER",
    "input": {
      "reason": "<string>"
    }
  }
}
'
import requests

url = "https://api.juo.io/admin/v1/schedules/adjustments"

payload = {
"customerId": "<string>",
"matcher": {
"type": "CYCLE",
"input": { "cycle": 1 }
},
"action": {
"type": "SKIP_ORDER",
"input": { "reason": "<string>" }
}
}
headers = {
"X-Tenant-ID": "<x-tenant-id>",
"X-Juo-Admin-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'X-Tenant-ID': '<x-tenant-id>',
'X-Juo-Admin-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customerId: '<string>',
matcher: {type: 'CYCLE', input: {cycle: 1}},
action: {type: 'SKIP_ORDER', input: {reason: '<string>'}}
})
};

fetch('https://api.juo.io/admin/v1/schedules/adjustments', 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.juo.io/admin/v1/schedules/adjustments",
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([
'customerId' => '<string>',
'matcher' => [
'type' => 'CYCLE',
'input' => [
'cycle' => 1
]
],
'action' => [
'type' => 'SKIP_ORDER',
'input' => [
'reason' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Juo-Admin-Api-Key: <api-key>",
"X-Tenant-ID: <x-tenant-id>"
],
]);

$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.juo.io/admin/v1/schedules/adjustments"

payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"matcher\": {\n \"type\": \"CYCLE\",\n \"input\": {\n \"cycle\": 1\n }\n },\n \"action\": {\n \"type\": \"SKIP_ORDER\",\n \"input\": {\n \"reason\": \"<string>\"\n }\n }\n}")

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

req.Header.Add("X-Tenant-ID", "<x-tenant-id>")
req.Header.Add("X-Juo-Admin-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.post("https://api.juo.io/admin/v1/schedules/adjustments")
.header("X-Tenant-ID", "<x-tenant-id>")
.header("X-Juo-Admin-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"matcher\": {\n \"type\": \"CYCLE\",\n \"input\": {\n \"cycle\": 1\n }\n },\n \"action\": {\n \"type\": \"SKIP_ORDER\",\n \"input\": {\n \"reason\": \"<string>\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.juo.io/admin/v1/schedules/adjustments")

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

request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = '<x-tenant-id>'
request["X-Juo-Admin-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"matcher\": {\n \"type\": \"CYCLE\",\n \"input\": {\n \"cycle\": 1\n }\n },\n \"action\": {\n \"type\": \"SKIP_ORDER\",\n \"input\": {\n \"reason\": \"<string>\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "schedule_adjustment",
  "customer": "<string>",
  "matcher": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "action": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "actor": {
    "id": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Examples

Skip order for the third cycle with a reason.
{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 3
    }
  },
  "action": {
    "type": "SKIP_ORDER",
    "input": {
      "reason": "Customer on vacation"
    }
  }
}

Authorizations

X-Juo-Admin-Api-Key
string
header
required

Long-lived Admin API key issued from the Juo merchant portal. Pass as the X-Juo-Admin-Api-Key header.

Headers

X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Body

application/json
customerId
string
required

The customer identifier

Minimum string length: 1
matcher
object
required

Match by cycle number

action
object
required

Skip an order in the schedule

Response

Default Response

id
string<uuid>
required

The adjustment identifier

resource
enum<string>
required
Available options:
schedule_adjustment
customer
string
required

The customer identifier

Minimum string length: 1
matcher
object
required
action
object
required
actor
object
required
createdAt
string<date-time>
required

Creation date of the adjustment

updatedAt
string<date-time>
required

Last update date of the adjustment