Place lot-level Hold (with optional BOM cascade)

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/holds/lot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lot_id": 142,
  "reason_code": "recalled",
  "cascade_bom": false,
  "notes": "Recall #123"
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/inventory/holds/lot"

payload = {
    "lot_id": 142,
    "reason_code": "recalled",
    "cascade_bom": False,
    "notes": "Recall #123"
}
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({lot_id: 142, reason_code: 'recalled', cascade_bom: false, notes: 'Recall #123'})
};

fetch('https://{base_url_domain}/api/global/v1/inventory/holds/lot', 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://{base_url_domain}/api/global/v1/inventory/holds/lot",
  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([
    'lot_id' => 142,
    'reason_code' => 'recalled',
    'cascade_bom' => false,
    'notes' => 'Recall #123'
  ]),
  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://{base_url_domain}/api/global/v1/inventory/holds/lot"

	payload := strings.NewReader("{\n  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\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://{base_url_domain}/api/global/v1/inventory/holds/lot")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/inventory/holds/lot")

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  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\n}"

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

{
  "origin": {
    "lot_id": 142,
    "created_origin_hold_ids": [
      501,
      502,
      503
    ]
  }
}

Holds

Place lot-level Hold (with optional BOM cascade)

Places holds on every active putaway location currently carrying the named lot. A lot-level hold is kept as well, so inventory of the lot put away later is held too.

cascade_bom=false (default) — the engine’s Hold::placeByLot path. Only the named lot is held.

cascade_bom=true — the engine’s Hold::cascadeLotHold path. The hold also covers every lot made from the named lot through work orders, recursively and within the same merchant: kit lots assembled with it (work_lot_input → work_lot) and component lots de-kitted from it (work_lot → work_component_lot). Lots the named lot was made from are never held. Each related lot gets its own lot-level hold under the named lot’s, and its locations are held in every warehouse. A related lot that already has a lot-level hold, for any reason, is left unchanged and listed in cascade.detached_lot_ids: it keeps that hold, and the quarantine covers it, so the lot moves into the quarantine when that hold ends. Locations already held for any reason are skipped.

With cascade_bom=true, if the named lot already has a lot-level hold, the call returns 422 and nothing is held, unless that hold is the lot’s own open quarantine with the same reason: then the quarantine is run again, and its related lots that were released on their own are held again. With cascade_bom=false, an existing lot-level hold with the same reason is reused and one with a different reason returns 422.

To lift the quarantine, release the named lot with POST /v1/inventory/holds/lot/{lot_id}/release and release_cascaded=true. The lots listed in cascade.detached_lot_ids keep their own hold: that release ends the quarantine’s cover, and their own hold is released with the same endpoint on each of them.

POST

inventory

holds

lot

Place lot-level Hold (with optional BOM cascade)

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/holds/lot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lot_id": 142,
  "reason_code": "recalled",
  "cascade_bom": false,
  "notes": "Recall #123"
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/inventory/holds/lot"

payload = {
    "lot_id": 142,
    "reason_code": "recalled",
    "cascade_bom": False,
    "notes": "Recall #123"
}
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({lot_id: 142, reason_code: 'recalled', cascade_bom: false, notes: 'Recall #123'})
};

fetch('https://{base_url_domain}/api/global/v1/inventory/holds/lot', 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://{base_url_domain}/api/global/v1/inventory/holds/lot",
  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([
    'lot_id' => 142,
    'reason_code' => 'recalled',
    'cascade_bom' => false,
    'notes' => 'Recall #123'
  ]),
  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://{base_url_domain}/api/global/v1/inventory/holds/lot"

	payload := strings.NewReader("{\n  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\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://{base_url_domain}/api/global/v1/inventory/holds/lot")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/inventory/holds/lot")

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  \"lot_id\": 142,\n  \"reason_code\": \"recalled\",\n  \"cascade_bom\": false,\n  \"notes\": \"Recall #123\"\n}"

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

{
  "origin": {
    "lot_id": 142,
    "created_origin_hold_ids": [
      501,
      502,
      503
    ]
  }
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Body

application/json

lot_id

integer<int64>

required

Lot to hold.

Example:

142

reason_code

string

required

Hold reason code.

Example:

"recalled"

cascade_bom

boolean

default:false

Cascade through BOM lineage.

Example:

false

notes

string | null

Free-form notes attached to the holds placed by this call.

Example:

"Recall #123"

Response

Lot hold placed.

origin

object

required

Show child attributes

cascade

object

Present only when cascade_bom=true. Every related lot of the same merchant is quarantined: it gets a lot-level hold, or keeps the one it already has (listed in detached_lot_ids). held_lots and the skipped_lots_no_putaway, skipped_lots_fully_already_held and skipped_lots_no_holdable_qty counts split the lots that got a lot-level hold by whether this call held stock now. Lots counted in skipped_lots_cross_merchant are not held.

Show child attributes

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Place lot-level Hold (with optional BOM cascade)

Authorizations

Body

Response