Deel: IT warehouses schemas
4 Deel schemas with complete fields and constraints.
← IT warehouses operations · All schemas
List warehouses — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve a warehouse — 200 response body — data |
has_more | boolean | Required within parent | Whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to the next page |
next_cursor (anyOf 2) | null | Alternative | Cursor to the next page |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of records Format: int64 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a warehouse — 200 response body — data
Retrieve a warehouse — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a warehouse — 200 response body — data |
Referenced models: Retrieve a warehouse — 200 response body — data
Retrieve a warehouse — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Required within parent | Warehouse address |
address (anyOf 1) | Model | Alternative | Expand Retrieve a warehouse — 200 response body — data / address / type: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER |
address (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | When the warehouse was created Format: date-time |
id | string | Required within parent | Unique identifier of the warehouse Format: uuid |
name | string | Required within parent | Warehouse or storage location name |
ownership | string | Required within parent | Warehouse ownership. Always ORGANIZATION for this endpoint. Known values: DEEL, ORGANIZATION |
public_id | string | Required within parent | Public identifier of the warehouse |
type | string | Required within parent | Organization warehouse type Known values: OFFICE, RESIDENCE, WAREHOUSE |
updated_at | string | Required within parent | When the warehouse was last updated Format: date-time |
warehouse_type | string | Required within parent | Warehouse 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Warehouse address |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address country Country code |
date_of_birth | JSON | Required within parent | |
date_of_birth (anyOf 1) | string | Alternative | Date of birth (applicable for some address types) Format: date |
date_of_birth (anyOf 2) | null | Alternative | Date of birth (applicable for some address types) Format: date |
delivery_instructions | JSON | Required within parent | |
delivery_instructions (anyOf 1) | string | Alternative | Special instructions for deliveries |
delivery_instructions (anyOf 2) | null | Alternative | Special instructions for deliveries |
id | string | Required within parent | Unique identifier of the address Format: uuid |
is_valid | boolean | Required within parent | Whether the address passes validation |
line1 | JSON | Required within parent | |
line1 (anyOf 1) | string | Alternative | Address line 1 |
line1 (anyOf 2) | null | Alternative | Address line 1 |
line2 | JSON | Required within parent | |
line2 (anyOf 1) | string | Alternative | Address line 2 |
line2 (anyOf 2) | null | Alternative | Address line 2 |
passport_number | JSON | Required within parent | |
passport_number (anyOf 1) | string | Alternative | Passport number (applicable for some address types) |
passport_number (anyOf 2) | null | Alternative | Passport number (applicable for some address types) |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Phone number |
phone_number (anyOf 2) | null | Alternative | Phone number |
post_code | JSON | Required within parent | |
post_code (anyOf 1) | string | Alternative | Post code |
post_code (anyOf 2) | null | Alternative | Post code |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State code or name |
state (anyOf 2) | null | Alternative | State code or name |
tax_id_number | JSON | Required within parent | |
tax_id_number (anyOf 1) | string | Alternative | Tax ID number (applicable for some address types) |
tax_id_number (anyOf 2) | null | Alternative | Tax ID number (applicable for some address types) |
type | string | Required within parent | Type 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