Reserve stock for an order
curl --request POST \
--url https://vitarelay.com/api/public/v1/inventory/allocations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qty": 2,
"reference": {
"type": "<string>",
"id": "<string>"
},
"sku_code": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": "<string>",
"lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://vitarelay.com/api/public/v1/inventory/allocations"
payload = {
"qty": 2,
"reference": {
"type": "<string>",
"id": "<string>"
},
"sku_code": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": "<string>",
"lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
qty: 2,
reference: {type: '<string>', id: '<string>'},
sku_code: '<string>',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
location: '<string>',
lot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://vitarelay.com/api/public/v1/inventory/allocations', 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://vitarelay.com/api/public/v1/inventory/allocations",
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([
'qty' => 2,
'reference' => [
'type' => '<string>',
'id' => '<string>'
],
'sku_code' => '<string>',
'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'location' => '<string>',
'lot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://vitarelay.com/api/public/v1/inventory/allocations"
payload := strings.NewReader("{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://vitarelay.com/api/public/v1/inventory/allocations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitarelay.com/api/public/v1/inventory/allocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>"
}
}API Reference
Reserve stock for an order
Scope inventory:write (live keys). Reserves released, unexpired stock first to expire first and returns the lots.
Repeating the request for the same reference reserves nothing twice; asking for more tops up only the difference.
POST
/
inventory
/
allocations
Reserve stock for an order
curl --request POST \
--url https://vitarelay.com/api/public/v1/inventory/allocations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qty": 2,
"reference": {
"type": "<string>",
"id": "<string>"
},
"sku_code": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": "<string>",
"lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://vitarelay.com/api/public/v1/inventory/allocations"
payload = {
"qty": 2,
"reference": {
"type": "<string>",
"id": "<string>"
},
"sku_code": "<string>",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": "<string>",
"lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
qty: 2,
reference: {type: '<string>', id: '<string>'},
sku_code: '<string>',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
location: '<string>',
lot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://vitarelay.com/api/public/v1/inventory/allocations', 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://vitarelay.com/api/public/v1/inventory/allocations",
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([
'qty' => 2,
'reference' => [
'type' => '<string>',
'id' => '<string>'
],
'sku_code' => '<string>',
'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'location' => '<string>',
'lot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://vitarelay.com/api/public/v1/inventory/allocations"
payload := strings.NewReader("{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://vitarelay.com/api/public/v1/inventory/allocations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitarelay.com/api/public/v1/inventory/allocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qty\": 2,\n \"reference\": {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"sku_code\": \"<string>\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": \"<string>\",\n \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Already reserved

