Skip to content

Deel: Retrieve a warehouse

Deel itWarehouses.retrieveAnItWarehouse: arguments, response, policy and SDK examples.

← IT warehouses operations · Get started

Operation deel.itwarehouses_retrieveanitwarehouse_v2026_09_15

Provider route: GET /it/warehouses/{warehouse_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["itWarehouses"]["retrieveAnItWarehouse"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.itWarehouses.retrieveAnItWarehouse(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.it_warehouses.retrieve_an_it_warehouse(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.warehouse_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a warehouse — 200 response body

Referenced models: Retrieve a warehouse — 200 response body

Retrieve a warehouse — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve a warehouse — 200 response body — data

Referenced models: Retrieve a warehouse — 200 response body — data

Retrieve a warehouse — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONRequired within parentWarehouse address
address (anyOf 1)ModelAlternativeExpand Retrieve a warehouse — 200 response body — data / address / type: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER
address (anyOf 2)nullAlternative
created_atstringRequired within parentWhen the warehouse was created
Format: date-time
idstringRequired within parentUnique identifier of the warehouse
Format: uuid
namestringRequired within parentWarehouse or storage location name
ownershipstringRequired within parentWarehouse ownership. Always ORGANIZATION for this endpoint.
Known values: DEEL, ORGANIZATION
public_idstringRequired within parentPublic identifier of the warehouse
typestringRequired within parentOrganization warehouse type
Known values: OFFICE, RESIDENCE, WAREHOUSE
updated_atstringRequired within parentWhen the warehouse was last updated
Format: date-time
warehouse_typestringRequired within parentWarehouse type. Always ORGANIZATION for this endpoint.
Known values: CLEARANCE, DEEL, ORGANIZATION

Referenced models: Retrieve a warehouse — 200 response body — data / address / type: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER

Retrieve a warehouse — 200 response body — data / address / type: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER
FieldTypePresenceDescription and constraints
$objectRootWarehouse address
cityJSONRequired within parent
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
countryModelRequired within parentExpand Cancel an IT order — 200 response body — data delivery address country
Country code
date_of_birthJSONRequired within parent
date_of_birth (anyOf 1)stringAlternativeDate of birth (applicable for some address types)
Format: date
date_of_birth (anyOf 2)nullAlternativeDate of birth (applicable for some address types)
Format: date
delivery_instructionsJSONRequired within parent
delivery_instructions (anyOf 1)stringAlternativeSpecial instructions for deliveries
delivery_instructions (anyOf 2)nullAlternativeSpecial instructions for deliveries
idstringRequired within parentUnique identifier of the address
Format: uuid
is_validbooleanRequired within parentWhether the address passes validation
line1JSONRequired within parent
line1 (anyOf 1)stringAlternativeAddress line 1
line1 (anyOf 2)nullAlternativeAddress line 1
line2JSONRequired within parent
line2 (anyOf 1)stringAlternativeAddress line 2
line2 (anyOf 2)nullAlternativeAddress line 2
passport_numberJSONRequired within parent
passport_number (anyOf 1)stringAlternativePassport number (applicable for some address types)
passport_number (anyOf 2)nullAlternativePassport number (applicable for some address types)
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativePhone number
phone_number (anyOf 2)nullAlternativePhone number
post_codeJSONRequired within parent
post_code (anyOf 1)stringAlternativePost code
post_code (anyOf 2)nullAlternativePost code
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState code or name
state (anyOf 2)nullAlternativeState code or name
tax_id_numberJSONRequired within parent
tax_id_number (anyOf 1)stringAlternativeTax ID number (applicable for some address types)
tax_id_number (anyOf 2)nullAlternativeTax ID number (applicable for some address types)
typestringRequired within parentType of the address
Known values: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER

Referenced models: Cancel an IT order — 200 response body — data delivery address country

Cancel an IT order — 200 response body — data delivery address country
FieldTypePresenceDescription and constraints
$stringRootCountry code
Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

SDK function policy ID: deel.itwarehouses_retrieveanitwarehouse_v2026_09_15. Catalog operation: itwarehouses_retrieveanitwarehouse_v2026_09_15. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["it-assets:read"]

Pinned headers: {"X-Version": "2026-09-15"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.