{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}
{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}
{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}
Holds
Place location-level Hold
Places an inventory hold on the specified location for the given reason. A hold freezes the
entire location: its on-shelf inventory becomes held — excluded from available and advertised
quantity and unavailable for allocation — until the hold is released.
Partial holds are not supported. qty is optional; when supplied it must equal the location’s
full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the
whole location is held.
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.
Optional. When supplied it must be > 0 and equal to the location's full on-shelf
qty; partial holds are not supported. When omitted, the whole location is held.
An inventory hold record. Cross-merchant view (Global API surface).
Releasing a lot quarantine: release the lot with POST /holds/lot/{lot_id}/release. When
holdLot was called with cascade_bom=true, add release_cascaded=true to release the
related lots quarantined with it as well.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"ShipStream Developer Center","colors":{"primary":"#2a81c4","light":"#2a81c4","dark":"#2a81c4"},"logo":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=b83b5ebc8570308bd06c53fdc32eb950","href":"https://shipstream.io"},"favicon":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=85c67af04fff1dac7f40844baf8c28d6","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=72f5d317204ffe6e66245125e71f9831"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:help@shipstream.io","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://shipstream.io"}},"footer":{"socials":{"github":"https://github.com/shipstream","linkedin":"https://linkedin.com/company/shipstream-llc"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shipstream","hasAudioNarration":false,"actualSubdomain":"shipstream","customDomains":["docs.shipstream.io"],"gitSource":{"type":"github","owner":"colinmollenhour","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acebedfad8927365d8e6b61","collectionId":"239e8646-2b14-4b40-9c87-6d42a5b1848a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acebedfad8927365d8e6b61"},"feedback":{"thumbs":true,"edits":false},"entitlements":{},"buildId":"6acebedfad8927365d8e6b61","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Global API Reference","count":143},{"language":"default","tag":"Inventory API v1","count":86},{"language":"default","tag":"Shipping API v1","count":37},{"language":"default","tag":"Merchant API Reference","count":31},{"language":"default","tag":"Retailers","count":26},{"language":"default","tag":"Slotting Rules","count":12},{"language":"default","tag":"Common Features","count":11},{"language":"default","tag":"Product Profiles","count":10},{"language":"default","tag":"System API v1","count":10},{"language":"default","tag":"Shipping","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"global-api/endpoint/v1/inventory/holds/location/post","slug":"/global-api/endpoint/v1/inventory/holds/location/post","pageMetadata":{"title":"Place location-level Hold","openapi":"POST /v1/inventory/holds/location","description":"Places an inventory hold on the specified location for the given reason. A hold freezes the\nentire location: its on-shelf inventory becomes held — excluded from available and advertised\nquantity and unavailable for allocation — until the hold is released.\n\nPartial holds are not supported. `qty` is optional; when supplied it must equal the location's\nfull on-shelf quantity at the time of the call, or the request returns 422. When omitted, the\nwhole location is held.","href":"/global-api/endpoint/v1/inventory/holds/location/post"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Places an inventory hold on the specified location for the given reason. A hold freezes the\\nentire location: its on-shelf inventory becomes held — excluded from available and advertised\\nquantity and unavailable for allocation — until the hold is released.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Partial holds are not supported. \", _jsx(_components.code, {\n children: \"qty\"\n }), \" is optional; when supplied it must equal the location’s\\nfull on-shelf quantity at the time of the call, or the request returns 422. When omitted, the\\nwhole location is held.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Place location-level Hold","openapi":"POST /v1/inventory/holds/location","description":"Places an inventory hold on the specified location for the given reason. A hold freezes the\nentire location: its on-shelf inventory becomes held — excluded from available and advertised\nquantity and unavailable for allocation — until the hold is released.\n\nPartial holds are not supported. `qty` is optional; when supplied it must equal the location's\nfull on-shelf quantity at the time of the call, or the request returns 422. When omitted, the\nwhole location is held.","href":"/global-api/endpoint/v1/inventory/holds/location/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Place location-level Hold","description":"Places an inventory hold on the specified location for the given reason. A hold freezes the\nentire location: its on-shelf inventory becomes held — excluded from available and advertised\nquantity and unavailable for allocation — until the hold is released.\n\nPartial holds are not supported. `qty` is optional; when supplied it must equal the location's\nfull on-shelf quantity at the time of the call, or the request returns 422. When omitted, the\nwhole location is held.","tags":["Holds"],"operationId":"holdLocation","requestBody":"150b83cf-dd93-4bfd-8c22-c8ab3dfca5f8","responses":{"201":"84944abe-aee0-4b32-bcc2-131d9b81240d","400":"c44e783b-387a-48b7-bc1d-d4140a5911f6","404":"06bd5e0c-d684-4c3b-89ea-161e32799139","422":"aabdf9a1-0b82-4a1f-95bd-732d1c406cd6","500":"b9f49742-a0e4-4584-b132-51a6f419eac3"},"method":"post","type":"path","servers":["c54ede43-9c1a-41e5-bd59-dd40a08d5ddf"],"security":["cdd0ed69-efb4-45cc-8b4d-1bf2ea905a01"],"path":"/v1/inventory/holds/location","baseUrlOptions":["https://{base_url_domain}/api/global"],"title":"Place location-level Hold","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location_id":{"type":"integer","format":"int64","description":"Target location.","example":6,"isRequired":true,"uniqueKey":"location_id","typeLabel":"integer\u003cint64>"},"reason_code":{"type":"string","description":"Hold reason code (system or user-defined).","example":"damaged","isRequired":true,"uniqueKey":"reason_code","typeLabel":"string"},"qty":{"oneOf":[{"type":"number","format":"float","description":"Optional. When supplied it must be > 0 and equal to the location's full on-shelf \nqty; partial holds are not supported. When omitted, the whole location is held.","example":5,"uniqueKey":"qty.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Optional. When supplied it must be > 0 and equal to the location's full on-shelf \nqty; partial holds are not supported. When omitted, the whole location is held.","example":5,"uniqueKey":"qty.oneOf.1","typeLabel":"null"}],"uniqueKey":"qty","typeLabel":"number\u003cfloat> | null"},"notes":{"oneOf":[{"type":"string","description":"Free-form notes.","example":"Damaged at receiving","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-form notes.","example":"Damaged at receiving","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"}},"required":["location_id","reason_code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"location_id":6,"reason_code":"damaged","qty":5,"notes":"Damaged at receiving"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"84944abe-aee0-4b32-bcc2-131d9b81240d":{"description":"Hold placed.","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"title":"Hold","type":"object","description":"An inventory hold record. Cross-merchant view (Global API surface).\n\n**Releasing a lot quarantine:** release the lot with `POST /holds/lot/{lot_id}/release`. When\n`holdLot` was called with `cascade_bom=true`, add `release_cascaded=true` to release the\nrelated lots quarantined with it as well.","properties":{"type":{"type":"string","enum":["Hold"],"readOnly":true,"isRequired":true,"uniqueKey":"resource.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int64","description":"Internal `hold_id` primary key.","readOnly":true,"example":142,"isRequired":true,"uniqueKey":"resource.id","typeLabel":"integer\u003cint64>"},"qty":{"type":"number","format":"float","description":"Held quantity.","example":12,"isRequired":true,"uniqueKey":"resource.qty","typeLabel":"number\u003cfloat>"},"held_at":{"type":"string","format":"date-time","description":"When the hold was placed.","example":"2026-04-28T14:32:00Z","isRequired":true,"uniqueKey":"resource.held_at","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["active","released"],"description":"Computed from released_at; 'active' when released_at IS NULL.","example":"active","isRequired":true,"uniqueKey":"resource.status","typeLabel":"enum\u003cstring>"},"merchant":{"type":"object","title":"MerchantRef","description":"Merchant that owns the held product.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"resource.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.merchant","typeLabel":"MerchantRef · object"},"warehouse":{"oneOf":[{"type":"object","title":"WarehouseRef","description":"Warehouse where the held inventory lives.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.warehouse.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.warehouse.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.warehouse.oneOf.0","typeLabel":"WarehouseRef · object"},{"type":"null","title":"WarehouseRef","description":"Warehouse where the held inventory lives.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"resource.warehouse.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.warehouse","typeLabel":"WarehouseRef · object | null"},"product":{"oneOf":[{"type":"object","title":"StockableProductRef","description":"Product whose inventory is on hold.","required":["type","id"],"properties":{"type":{"type":"string","description":"This is a read-only property that describes the type of object in the response body.","enum":["Product","PackagingContainer","PackagingInfill","PackagingSupplies"],"isRequired":true,"uniqueKey":"resource.product.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","format":"int32","isRequired":true,"uniqueKey":"resource.product.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.product.oneOf.0","typeLabel":"StockableProductRef · object"},{"type":"null","title":"StockableProductRef","description":"Product whose inventory is on hold.","required":["type","id"],"properties":{"type":{"type":"string","description":"This is a read-only property that describes the type of object in the response body.","enum":["Product","PackagingContainer","PackagingInfill","PackagingSupplies"]},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","format":"int32"}},"additionalProperties":false,"uniqueKey":"resource.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.product","typeLabel":"StockableProductRef · object | null"},"location":{"oneOf":[{"type":"object","title":"LocationRef","description":"Specific location holding the inventory (label included).","required":["type","id"],"properties":{"type":{"type":"string","description":"This property describes the type of object in the response body.","enum":["Location"],"isRequired":true,"uniqueKey":"resource.location.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":42,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.location.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.location.oneOf.0","typeLabel":"LocationRef · object"},{"type":"null","title":"LocationRef","description":"Specific location holding the inventory (label included).","required":["type","id"],"properties":{"type":{"type":"string","description":"This property describes the type of object in the response body.","enum":["Location"]},"id":{"type":"integer","format":"int32","example":42,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"resource.location.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.location","typeLabel":"LocationRef · object | null"},"lot":{"oneOf":[{"type":"object","title":"LotRef","description":"Lot whose inventory is on hold (NULL when the hold is location-scope without a lot).","required":["type","id"],"properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.lot.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.lot.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"resource.lot.oneOf.0","typeLabel":"LotRef · object"},{"type":"null","title":"LotRef","description":"Lot whose inventory is on hold (NULL when the hold is location-scope without a lot).","required":["type","id"],"properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"resource.lot.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"resource.lot.oneOf.2","typeLabel":"null"}],"uniqueKey":"resource.lot","typeLabel":"LotRef · object · null · null"},"reason":{"type":"object","description":"Hold reason — emitted inline with parent_code resolved.","properties":{"code":{"type":"string","description":"Reason code (system or user-defined).","example":"damaged","isRequired":true,"uniqueKey":"resource.reason.code","typeLabel":"string"},"label":{"type":"string","description":"Human-readable reason label.","example":"Damaged","isRequired":true,"uniqueKey":"resource.reason.label","typeLabel":"string"},"parent_code":{"oneOf":[{"type":"string","description":"Parent (system) reason code; NULL when this reason is itself a system parent.","example":"damaged","uniqueKey":"resource.reason.parent_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parent (system) reason code; NULL when this reason is itself a system parent.","example":"damaged","uniqueKey":"resource.reason.parent_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.reason.parent_code","typeLabel":"string | null"}},"required":["code","label"],"uniqueKey":"resource.reason","typeLabel":"object"},"held_by":{"oneOf":[{"type":"object","title":"RequesterRef","description":"Requester who placed the hold (admin user, client user, API key, integration, etc.).","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"resource.held_by.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"resource.held_by.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.held_by.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"resource.held_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.held_by","typeLabel":"RequesterRef · object | null"},"released_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the hold was released (NULL while still active).","example":null,"uniqueKey":"resource.released_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the hold was released (NULL while still active).","example":null,"uniqueKey":"resource.released_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.released_at","typeLabel":"string\u003cdate-time> | null"},"released_by":{"oneOf":[{"type":"object","title":"RequesterRef","description":"Requester who released the hold.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"resource.released_by.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"resource.released_by.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.released_by.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"resource.released_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.released_by","typeLabel":"RequesterRef · object | null"},"notes":{"oneOf":[{"type":"string","description":"Free-form notes attached at place / release time.","example":"Damaged in receiving","uniqueKey":"resource.notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-form notes attached at place / release time.","example":"Damaged in receiving","uniqueKey":"resource.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.notes","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Last meaningful timestamp (released_at when present, otherwise held_at).","example":"2026-04-28T14:32:00Z","uniqueKey":"resource.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last meaningful timestamp (released_at when present, otherwise held_at).","example":"2026-04-28T14:32:00Z","uniqueKey":"resource.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","id","qty","held_at","status"],"uniqueKey":"resource","typeLabel":"Hold · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"resource":{"type":"Hold","id":142,"qty":12,"held_at":"2026-04-28T14:32:00Z","status":"active","merchant":{"type":"Merchant","id":4},"warehouse":{"type":"Warehouse","id":123},"product":{"type":"Product","id":123},"location":{"type":"Location","id":42},"lot":{"type":"Lot","id":54},"reason":{"code":"damaged","label":"Damaged","parent_code":"damaged"},"held_by":{"type":"Requester","id":3},"released_at":null,"released_by":{"type":"Requester","id":3},"notes":"Damaged in receiving","updated_at":"2026-04-28T14:32:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c44e783b-387a-48b7-bc1d-d4140a5911f6":{"description":"The request was invalid. The client must change the request. See the response body for more details.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["parser","parameters","openapi"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"06bd5e0c-d684-4c3b-89ea-161e32799139":{"description":"The requested resource was not found. It may have been deleted, it may have never existed, or you may not have permission to view it.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["not_found"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"aabdf9a1-0b82-4a1f-95bd-732d1c406cd6":{"description":"There was an error processing the request. See the response body for more details.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["application","unable_to_process"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"unable_to_process","message":"There was an error processing the request."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"unable_to_process","message":"There was an error processing the request."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"b9f49742-a0e4-4584-b132-51a6f419eac3":{"description":"Internal Server Error - Something wrong happened at server side. Contact server administrator for more details.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"cdd0ed69-efb4-45cc-8b4d-1bf2ea905a01":{"ShipStream_bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"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.","scopes":[],"schemeName":"ShipStream_bearerAuth"}}},"servers":{"c54ede43-9c1a-41e5-bd59-dd40a08d5ddf":{"url":"https://{base_url_domain}/api/global","description":"Direct API Url","variables":{"base_url_domain":{"default":"example.shipstream.app","description":"The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app,\nand will be the same as the domain name for the page which you use to login to ShipStream WMS."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"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.","scopes":[],"schemeName":"ShipStream_bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ShipStream_bearerAuth","name":"Authorization"}],"title":"ShipStream_bearerAuth"}]},"originalFileLocation":"global-api/openapi.json"},"subdomain":"shipstream","siteName":"ShipStream Developer Center","title":"Place location-level Hold - ShipStream Developer Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-07T16:05:25.854Z","originalFileLocation":"global-api/endpoint/v1/inventory/holds/location/post.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Places an inventory hold on the specified location for the given reason. A hold freezes the entire location: its on-shelf inventory becomes held — excluded from available and advertised quantity and unavailable for allocation — until the hold is released. Partial holds are not supported. qty is optional; when supplied it must equal the location\u0026#x27;s full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the whole location is held.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Place location-level Hold - ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Places an inventory hold on the specified location for the given reason. A hold freezes the entire location: its on-shelf inventory becomes held — excluded from available and advertised quantity and unavailable for allocation — until the hold is released. Partial holds are not supported. qty is optional; when supplied it must equal the location\u0026#x27;s full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the whole location is held.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shipstream.mintlify.app/_mintlify/api/og/v2?division=Holds\u0026amp;title=Place+location-level+Hold\u0026amp;description=Places+an+inventory+hold+on+the+specified+location+for+the+given+reason.+A+hold+freezes+the%0Aentire+location%3A+its+on-shelf+inventory+becomes+held+%E2%80%94+excluded+from\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=35656372ba91fe0ebf8d04334da87123d823aaea680006a7d764373f22b71963\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Place location-level Hold - ShipStream Developer Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Places an inventory hold on the specified location for the given reason. A hold freezes the entire location: its on-shelf inventory becomes held — excluded from available and advertised quantity and unavailable for allocation — until the hold is released. Partial holds are not supported. qty is optional; when supplied it must equal the location\u0026#x27;s full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the whole location is held.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shipstream.mintlify.app/_mintlify/api/og/v2?division=Holds\u0026amp;title=Place+location-level+Hold\u0026amp;description=Places+an+inventory+hold+on+the+specified+location+for+the+given+reason.+A+hold+freezes+the%0Aentire+location%3A+its+on-shelf+inventory+becomes+held+%E2%80%94+excluded+from\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=35656372ba91fe0ebf8d04334da87123d823aaea680006a7d764373f22b71963\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2a81c4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/global-api/endpoint/v1/inventory/holds/location/post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shipstream.io/#organization\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shipstream.io#website\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post#webpage\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post\",\"name\":\"Place location-level Hold\",\"description\":\"Places an inventory hold on the specified location for the given reason. A hold freezes the entire location: its on-shelf inventory becomes held — excluded from available and advertised quantity and unavailable for allocation — until the hold is released. Partial holds are not supported. qty is optional; when supplied it must equal the location's full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the whole location is held.\",\"dateModified\":\"2026-08-07T16:05:25.854Z\",\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Inventory API v1\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Holds\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Place location-level Hold\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post#apireference\",\"headline\":\"Place location-level Hold\",\"name\":\"Place location-level Hold\",\"description\":\"Places an inventory hold on the specified location for the given reason. A hold freezes the entire location: its on-shelf inventory becomes held — excluded from available and advertised quantity and unavailable for allocation — until the hold is released. Partial holds are not supported. qty is optional; when supplied it must equal the location's full on-shelf quantity at the time of the call, or the request returns 422. When omitted, the whole location is held.\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/holds/location/post#webpage\"},\"dateModified\":\"2026-08-07T16:05:25.854Z\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ShipStream Developer Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ShipStream Developer Center","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Global API Reference","groups":[{"group":"Get Started","pages":[{"title":"Introduction","mode":"wide","href":"/global-api/introduction"},{"title":"Authentication","href":"/global-api/authentication"},{"title":"Versions","href":"/global-api/versions"}]},{"group":"Common Features","pages":[{"title":"Paging Parameters","href":"/global-api/paging-parameters"},{"title":"Sorting Syntax","href":"/global-api/sorting-syntax"},{"title":"Filtering Syntax","href":"/global-api/filtering-syntax"},{"title":"Selecting Fields","href":"/global-api/selecting-fields"},{"title":"Response Codes and Errors","href":"/global-api/response-codes-errors"}]},{"group":"Inventory API v1","pages":[{"group":"Warehouses","pages":[{"title":"List all Warehouses","openapi":"GET /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/get"},{"title":"Create Warehouse","openapi":"POST /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/post"},{"title":"Get one Warehouse","openapi":"GET /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/get"},{"title":"Update Warehouse","openapi":"PUT /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/put"},{"title":"Delete Warehouse","openapi":"DELETE /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/delete"}]},{"group":"Locations","pages":[{"title":"List all Locations","openapi":"GET /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/get"},{"title":"Create Location","openapi":"POST /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/post"},{"title":"Get one Location","openapi":"GET /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/get"},{"title":"Update Location","openapi":"PUT /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/put"},{"title":"Delete Location","openapi":"DELETE /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/delete"},{"title":"Get Location by Label","openapi":"GET /v1/inventory/warehouses/{id}/locationsByLabel/{label}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get"},{"title":"Batch update Locations","openapi":"POST /v1/inventory/warehouses/{id}/locations/batch","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/batch/post"},{"title":"Batch Update Location Tags","openapi":"POST /v1/inventory/warehouses/{id}/locations/tags","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/tags/post"}]},{"group":"Location Tags","pages":[{"title":"List Location Tags","openapi":"GET /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/get"},{"title":"Create Location Tag","openapi":"POST /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/post"},{"title":"Get one Location Tag","openapi":"GET /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/get"},{"title":"Update Location Tag","openapi":"PUT /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/put"},{"title":"Delete Location Tag","openapi":"DELETE /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/delete"}]},{"group":"Slot Types","pages":[{"title":"List Slot Types","openapi":"GET /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/get"},{"title":"Create Slot Type","openapi":"POST /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/post"},{"title":"Get one Slot Type","openapi":"GET /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/get"},{"title":"Update Slot Type","openapi":"PUT /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/put"},{"title":"Delete Slot Type","openapi":"DELETE /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/delete"}]},{"group":"Location Profiles","pages":[{"title":"List Location Profiles","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/get"},{"title":"Create Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/post"},{"title":"Get Location Profile","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/get"},{"title":"Update Location Profile","openapi":"PUT /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/put"},{"title":"Delete Location Profile","openapi":"DELETE /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/delete"},{"title":"List Location Profile member Locations","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations/get"},{"title":"Rebuild Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild/post"}]},{"group":"Products","pages":[{"title":"List all Products and Packaging","openapi":"GET /v1/inventory/products/{type}","href":"/global-api/endpoint/v1/inventory/products/{type}/get"},{"title":"Get Product or Packaging","openapi":"GET /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/get"},{"title":"Update Product or Packaging","openapi":"PUT /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/put"},{"title":"Create Product or Packaging","openapi":"POST /v1/inventory/products","href":"/global-api/endpoint/v1/inventory/products/post"},{"title":"Get Product Classifications","openapi":"GET /v1/inventory/products/{type}/{id}/classifications","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/classifications/get"}]},{"group":"Product Profiles","pages":[{"title":"Editing Product Profile Conditions","href":"/global-api/product-profile-conditions"},{"title":"List Product Profiles","openapi":"GET /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/get"},{"title":"Create Product Profile","openapi":"POST /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/post"},{"title":"List Product Profile condition fields","openapi":"GET /v1/inventory/product-profiles/condition-fields","href":"/global-api/endpoint/v1/inventory/product-profiles/condition-fields/get"},{"title":"Get Product Profile by code","openapi":"GET /v1/inventory/product-profiles/by-code/{code}","href":"/global-api/endpoint/v1/inventory/product-profiles/by-code/{code}/get"},{"title":"Get Product Profile","openapi":"GET /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/get"},{"title":"Update Product Profile","openapi":"PUT /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/put"},{"title":"Delete Product Profile","openapi":"DELETE /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/delete"},{"title":"List Product Profile member Products","openapi":"GET /v1/inventory/product-profiles/{id}/products","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/products/get"},{"title":"List Product condition values","openapi":"GET /v1/inventory/product-condition-values","href":"/global-api/endpoint/v1/inventory/product-condition-values/get"}]},{"group":"Handling Classes","pages":[{"title":"Editing Handling Class Conditions","href":"/global-api/handling-class-conditions"},{"title":"List Handling Classes","openapi":"GET /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/get"},{"title":"Create Handling Class","openapi":"POST /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/post"},{"title":"List Handling Class condition fields","openapi":"GET /v1/inventory/handling-classes/condition-fields","href":"/global-api/endpoint/v1/inventory/handling-classes/condition-fields/get"},{"title":"Get Handling Class by code","openapi":"GET /v1/inventory/handling-classes/by-code/{code}","href":"/global-api/endpoint/v1/inventory/handling-classes/by-code/{code}/get"},{"title":"Get Handling Class","openapi":"GET /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/get"},{"title":"Update Handling Class","openapi":"PUT /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/put"},{"title":"Delete Handling Class","openapi":"DELETE /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/delete"}]},{"group":"Slotting Rules","pages":[{"title":"List Slotting Rule Sets","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/get"},{"title":"Create Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/post"},{"title":"Get Slotting Rule Set","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/get"},{"title":"Update Slotting Rule Set","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/put"},{"title":"Delete Slotting Rule Set","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/delete"},{"title":"Duplicate Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate/post"},{"title":"List Slotting Rules","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/get"},{"title":"Create Slotting Rule","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/post"},{"title":"Get Slotting Rule","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/get"},{"title":"Update Slotting Rule","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/put"},{"title":"Delete Slotting Rule","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/delete"},{"title":"List Slotting Conflicts","openapi":"GET /v1/inventory/warehouses/{id}/slotting-conflicts","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-conflicts/get"}]},{"group":"Replenishment","pages":[{"title":"List Policies","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/get"},{"title":"Create Policy","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/post"},{"title":"List Policy Options","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/options","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/options/get"},{"title":"Get Policy","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/get"},{"title":"Update Policy","openapi":"PUT /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/put"},{"title":"Delete Policy","openapi":"DELETE /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/delete"},{"title":"List Report Rows","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-report","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-report/get"},{"title":"Get Replenishment Index Status","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-index/status","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/status/get"},{"title":"Rebuild Replenishment Index","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-index/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/rebuild/post"}]},{"group":"Levels","pages":[{"title":"List total inventory levels","openapi":"GET /v1/inventory/levels/total","href":"/global-api/endpoint/v1/inventory/levels/total/get"},{"title":"List warehouse inventory levels","openapi":"GET /v1/inventory/levels/warehouse","href":"/global-api/endpoint/v1/inventory/levels/warehouse/get"}]},{"group":"HoldReasons","pages":[{"title":"List active hold reasons","openapi":"GET /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/get"},{"title":"Create user-defined hold reason","openapi":"POST /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/post"},{"title":"Update hold reason","openapi":"PUT /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/put"},{"title":"Delete user-defined hold reason","openapi":"DELETE /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/delete"}]},{"group":"Holds","pages":[{"title":"List / search inventory holds","openapi":"GET /v1/inventory/holds","href":"/global-api/endpoint/v1/inventory/holds/get"},{"title":"Get one Hold by ID","openapi":"GET /v1/inventory/holds/{id}","description":"Returns a single `Hold` object specified by a hold `id` path parameter.","href":"/global-api/endpoint/v1/inventory/holds/{id}/get"},{"title":"Place location-level Hold","openapi":"POST /v1/inventory/holds/location","href":"/global-api/endpoint/v1/inventory/holds/location/post"},{"title":"Place lot-level Hold (with optional BOM cascade)","openapi":"POST /v1/inventory/holds/lot","description":"Places holds on every active putaway location currently carrying the named lot. A lot-level\nhold is kept as well, so inventory of the lot put away later is held too.\n\n`cascade_bom=false` (default) — the engine's `Hold::placeByLot` path. Only the named lot is held.\n\n`cascade_bom=true` — the engine's `Hold::cascadeLotHold` path. The hold also covers every lot\nmade from the named lot through work orders, recursively and within the same merchant: kit\nlots assembled with it (`work_lot_input` → `work_lot`) and component lots de-kitted from it\n(`work_lot` → `work_component_lot`). Lots the named lot was made from are never held. Each\nrelated lot gets its own lot-level hold under the named lot's, and its locations are held in\nevery warehouse. A related lot that already has a lot-level hold, for any reason, is left\nunchanged and listed in `cascade.detached_lot_ids`: it keeps that hold, and the quarantine\ncovers it, so the lot moves into the quarantine when that hold ends. Locations already held for\nany reason are skipped.\n\nWith `cascade_bom=true`, if the named lot already has a lot-level hold, the call returns 422 and\nnothing is held, unless that hold is the lot's own open quarantine with the same reason: then the\nquarantine is run again, and its related lots that were released on their own are held again.\nWith `cascade_bom=false`, an existing lot-level hold with the same reason is reused and one with a\ndifferent reason returns 422.\n\nTo lift the quarantine, release the named lot with\n`POST /v1/inventory/holds/lot/{lot_id}/release` and `release_cascaded=true`. The lots listed in\n`cascade.detached_lot_ids` keep their own hold: that release ends the quarantine's cover, and\ntheir own hold is released with the same endpoint on each of them.","href":"/global-api/endpoint/v1/inventory/holds/lot/post"},{"title":"Release one Hold by ID","openapi":"POST /v1/inventory/holds/{id}/release","href":"/global-api/endpoint/v1/inventory/holds/{id}/release/post"},{"title":"Release all active Holds on Lot","openapi":"POST /v1/inventory/holds/lot/{lot_id}/release","href":"/global-api/endpoint/v1/inventory/holds/lot/{lot_id}/release/post"}]}]},{"group":"Receiving API v1","pages":[{"group":"Deliveries","pages":[{"title":"List all Deliveries","openapi":"GET /v1/receiving/{type}","href":"/global-api/endpoint/v1/receiving/{type}/get"},{"title":"Get one Delivery","openapi":"GET /v1/receiving/{type}/{id}","href":"/global-api/endpoint/v1/receiving/{type}/{id}/get"}]}]},{"group":"Shipping API v1","pages":[{"group":"Shipments","pages":[{"title":"List all Shipments","openapi":"GET /v1/shipping/shipments","href":"/global-api/endpoint/v1/shipping/shipments/get"},{"title":"Get one Shipment","openapi":"GET /v1/shipping/shipments/{id}","href":"/global-api/endpoint/v1/shipping/shipments/{id}/get"},{"title":"Process Shipment","openapi":"POST /v1/shipping/shipments/{id}/process","href":"/global-api/endpoint/v1/shipping/shipments/{id}/process/post"},{"title":"Pick Shipment","openapi":"POST /v1/shipping/shipments/{id}/pick","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pick/post"},{"title":"Pack Shipment","openapi":"POST /v1/shipping/shipments/{id}/pack","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pack/post"},{"title":"Mark Shipment as Shipped","openapi":"POST /v1/shipping/shipments/{id}/shipped","href":"/global-api/endpoint/v1/shipping/shipments/{id}/shipped/post"},{"title":"Get Shipment Reservations","openapi":"GET /v1/shipping/shipments/{id}/reservations","href":"/global-api/endpoint/v1/shipping/shipments/{id}/reservations/get"}]},{"group":"Orders","pages":[{"title":"Mass update orders","openapi":"POST /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/post"},{"title":"List all Orders","openapi":"GET /v1/shipping/orders","href":"/global-api/endpoint/v1/shipping/orders/get"},{"title":"Get one Order","openapi":"GET /v1/shipping/orders/{id}","href":"/global-api/endpoint/v1/shipping/orders/{id}/get"},{"title":"Method not allowed","openapi":"GET /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/get"}]},{"group":"Retailers","pages":[{"title":"List all Retailers","openapi":"GET /v1/shipping/retailers","href":"/global-api/endpoint/v1/shipping/retailers/get"},{"title":"Create Retailer","openapi":"POST /v1/shipping/retailers","href":"/global-api/endpoint/v1/shipping/retailers/post"},{"title":"Get one Retailer","openapi":"GET /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/get"},{"title":"Update Retailer","openapi":"PUT /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/put"},{"title":"Delete Retailer","openapi":"DELETE /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/delete"},{"title":"List Retailer Identifiers","openapi":"GET /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/get"},{"title":"Create Retailer Identifier","openapi":"POST /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/post"},{"title":"Get one Retailer Identifier","openapi":"GET /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/get"},{"title":"Update Retailer Identifier","openapi":"PUT /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/put"},{"title":"Delete Retailer Identifier","openapi":"DELETE /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/delete"},{"title":"List Retailer Ship-To Locations","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/get"},{"title":"Create Retailer Ship-To Location","openapi":"POST /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/post"},{"title":"Get one Retailer Ship-To Location","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/get"},{"title":"Update Retailer Ship-To Location","openapi":"PUT /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/put"},{"title":"Delete Retailer Ship-To Location","openapi":"DELETE /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/delete"},{"title":"List Retailer Routing Guides","openapi":"GET /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/get"},{"title":"Create Retailer Routing Guide","openapi":"POST /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/post"},{"title":"Get one Retailer Routing Guide","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/get"},{"title":"Update Retailer Routing Guide metadata","openapi":"PUT /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/put"},{"title":"Delete Retailer Routing Guide","openapi":"DELETE /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/delete"},{"title":"Get Retailer Routing Guide file content","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}/file","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/file/get"},{"title":"List Retailer Merchant Settings","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/get"},{"title":"Create Retailer Merchant Setting","openapi":"POST /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/post"},{"title":"Get one Retailer Merchant Setting","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/get"},{"title":"Update Retailer Merchant Setting","openapi":"PUT /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/put"},{"title":"Delete Retailer Merchant Setting","openapi":"DELETE /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/delete"}]}]},{"group":"System API v1","pages":[{"group":"Merchants","pages":[{"title":"List all Merchants","openapi":"GET /v1/system/merchants","href":"/global-api/endpoint/v1/system/merchants/get"}]},{"group":"Users","pages":[{"title":"List all Users","openapi":"GET /v1/system/users/{type}","href":"/global-api/endpoint/v1/system/users/{type}/get"},{"title":"Get one User","openapi":"GET /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/get"},{"title":"Update one User","openapi":"PUT /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/put"},{"title":"Delete User","openapi":"DELETE /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/delete"}]},{"group":"User Roles","pages":[{"title":"List all User Roles","openapi":"GET /v1/system/userRoles/{type}","href":"/global-api/endpoint/v1/system/userRoles/{type}/get"},{"title":"Get one User Role","openapi":"GET /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/get"},{"title":"Update one User Role","openapi":"PUT /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/put"},{"title":"Delete User Role","openapi":"DELETE /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/delete"}]},{"group":"Healthcheck","pages":[{"title":"Healthcheck","openapi":"GET /v1/system/status","href":"/global-api/endpoint/v1/system/status/get"}]}]}]},{"tab":"Merchant API Reference","pages":[{"title":"Merchant API Reference","href":"/merchant-api/introduction"}]}]},"title":"Place location-level Hold - ShipStream Developer Center","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}