Catalog & inventory

Space

Warehouse or rentable space of the account.

Schemas: SpaceDto, SpaceDetailDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "internalReference": "string",
  "isWarehouse": true,
  "collectionId": "string",
  "collectionName": "Example",
  "building": "string",
  "floor": 1,
  "location": {
    "address": "string",
    "city": "string",
    "postalCode": "string",
    "country": "ES",
    "lat": 1,
    "lng": 1
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "description": "string",
  "capacity": 1,
  "area": 1,
  "dimensions": "string",
  "amenities": [
    "string"
  ],
  "equipments": [
    "string"
  ],
  "pricingSettings": {
    "type": "periodPrice",
    "price": "1234.50",
    "period": "hour"
  },
  "insuranceEnabled": true,
  "discountEnabled": true,
  "depositValue": "1234.50",
  "bufferBefore": 1,
  "bufferBeforeUnit": "hour",
  "bufferAfter": 1,
  "bufferAfterUnit": "hour",
  "customFields": {
    "key": "string"
  }
}

Generated from the schema

A warehouse that manages stock, or a rentable space; isWarehouse tells them apart. The holding costs of the space are not part of the public contract. Spaces are bounded to the subscription that owns the key. The detail read, GET /api/v1/spaces/{spaceId}, adds the description, capacity, area, dimensions, amenities, equipment, pricing settings, buffers and custom fields.

Attributes

idstring

Unique space identifier.

namestring

Space name.

internalReferencestring | null

Internal reference of the space, useful for matching with external systems; null if it has none.

isWarehouseboolean

true if the space is a warehouse that manages stock and can be the main warehouse of an order; false if it is a rentable space.

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Full collection path, for example "Estudios > Fotografía"; null if not applicable.

buildingstring | null

Building it is located in; null if not applicable.

floornumber | null

Floor it is located on; null if not applicable.

locationobject

Physical location of the space.

Show child attributes

location.addressstring | null

Postal address; null if not recorded.

location.citystring | null

Municipality; null if not recorded.

location.postalCodestring | null

Postal code; null if not recorded.

location.countrystring | null

Country; null if not recorded.

location.latnumber | null

Latitude in decimal degrees; null if not geolocated.

location.lngnumber | null

Longitude in decimal degrees; null if not geolocated.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

descriptionstring | nullonly in the detail

Space description; null if it has none.

capacitynumber | nullonly in the detail

Capacity in people; null if not defined.

areanumber | nullonly in the detail

Area in square metres; null if not defined.

dimensionsstring | nullonly in the detail

Dimensions as free text; null if not defined.

amenitiesstring[]only in the detail

Additional services available (wifi, projector...).

equipmentsstring[]only in the detail

Fixed equipment available in the space.

pricingSettingsobject | nullonly in the detail

Rental pricing of the space; null if not configured. The same fields that PATCH /pricing accepts.

Show child attributes

pricingSettings.typestring | null

Pricing mode; null if not configured.

Available options: periodPrice, fixedPrice, pricingStructure

pricingSettings.pricestring | null

Base rental price as a decimal string; null if not configured.

Limits: pattern ^-?\d+\.\d{2}$

pricingSettings.periodstring | null

Period unit of the price; null if not configured.

Available options: hour, day, week, month

insuranceEnabledbooleanonly in the detail

Whether the space allows insurance.

discountEnabledbooleanonly in the detail

Whether the space allows a discount.

depositValuestring | nullonly in the detail

Security deposit amount as a decimal string; null if not set.

Limits: pattern ^-?\d+\.\d{2}$

bufferBeforenumber | nullonly in the detail

Time buffer reserved BEFORE the rental; null if none.

bufferBeforeUnitstring | nullonly in the detail

Unit of the preceding buffer; null if none.

Available options: hour, day

bufferAfternumber | nullonly in the detail

Time buffer reserved AFTER the rental; null if none.

bufferAfterUnitstring | nullonly in the detail

Unit of the following buffer; null if none.

Available options: hour, day

customFieldsobject<string, any>only in the detail

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

Values

bufferBeforeUnit: hour, day
bufferAfterUnit: hour, day

Returned by

GET /api/v1/spaces — List warehouses and spaces
GET /api/v1/spaces/{spaceId} — Get a warehouse or space

Modified by

PATCH /api/v1/spaces/{spaceId} — Update a warehouse or space
PUT /api/v1/spaces/{spaceId}/amenities — Replace the amenities and equipment
PATCH /api/v1/spaces/{spaceId}/pricing — Update the pricing of a space

Was this page helpful?