For AI agents: markdown of this page — /docs-content-en/entities/warehouses/get.md documentation index — /llms.txt

Get a warehouse

GET /v1/warehouses/:id

Returns a single warehouse by identifier with all fields.

Path parameters

Parameter Type Description
Parameterid Typenumber DescriptionWarehouse identifier

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/warehouses/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/warehouses/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/warehouses/1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.title)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/warehouses/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionWarehouse object — fields listed below

Warehouse fields

Field Type Description
Fieldid Typenumber DescriptionWarehouse identifier
Fieldtitle Typestring DescriptionWarehouse name
Fieldaddress Typestring DescriptionWarehouse address
Fieldactive Typestring DescriptionActive flag: "Y" / "N"
FieldissuingCenter Typestring DescriptionOrder pickup point flag: "Y" / "N"
Fielddescription Typestring | null DescriptionWarehouse description. null if not set
Fieldphone Typestring | null DescriptionContact phone. null if not set
Fieldemail Typestring | null DescriptionContact email. null if not set
Fieldschedule Typestring | null DescriptionWorking hours. null if not set
Fieldsort Typenumber DescriptionSort order
Fieldcode Typestring | null DescriptionSymbolic code. null if not set
FieldxmlId Typestring | null DescriptionExternal identifier. null if not set
FieldgpsN Typenumber | null DescriptionGeographic latitude. null if not set
FieldgpsS Typenumber | null DescriptionGeographic longitude. null if not set
FieldimageId Typeobject | null DescriptionWarehouse image: { "id", "url" } or null
FielduserId Typenumber | null DescriptionResponsible employee. null for system warehouses, populated when created via the API
FieldmodifiedBy Typenumber | null DescriptionIdentifier of the user who last modified the warehouse. null for system warehouses, populated when created via the API
FielddateCreate Typedatetime | null DescriptionCreation date. null for some system warehouses (for example, marketplaces)
FielddateModify Typedatetime DescriptionLast modification date

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Main warehouse",
    "address": "1 Harbour Street, Amsterdam",
    "active": "Y",
    "issuingCenter": "N",
    "description": "Central warehouse",
    "phone": "+12025550123",
    "email": "warehouse@example.com",
    "schedule": "Mon–Fri 9:00–20:00",
    "sort": 100,
    "code": "main",
    "xmlId": null,
    "gpsN": 52.377956,
    "gpsS": 4.897070,
    "imageId": {
      "id": 57,
      "url": "https://cdn.bitrix24.com/b00000000/catalog/store.png"
    },
    "userId": 1,
    "modifiedBy": 1,
    "dateCreate": "2024-01-15T09:00:00+00:00",
    "dateModify": "2024-06-20T14:30:00+00:00"
  }
}

Error response example

404 — a warehouse with this id does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "store does not exist."
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a canonical positive integer: 12.5, 12abc, 1e2, 007 are rejected before the Bitrix24 call
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionA warehouse with the specified id does not exist

The full list of common API errors — Errors.

Known specifics

A nonexistent warehouse is 404. Requesting a warehouse by an unknown id returns 404 with code ENTITY_NOT_FOUND, the same as catalog products and prices. The message field still carries the Bitrix24 text store does not exist..

Warehouse image. The imageId field comes as an object { "id", "url" } with a link to the warehouse image, or null if no image is set.

See also