Entities

Stock Location

Warehouse, distribution center, or fulfillment location

A StockLocation is a place where stock is held: a warehouse, distribution center, fulfillment store, or pickup point. It is distinct from the retail-facing Location, which carries opening hours, services, media, and SEO.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

StockLocationBase

base

Name, code, location type, source identifier, description, and custom fields.

Schema

name

stringrequired

Display name of the stock location.

code

string

Human/ERP code distinct from the internal id.

type

string

description

string

Free-text description.

externalId

string

Identifier of this location in the source system it was imported from.

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Address

StockLocationAddress

address

Optional shipping-origin address and geographic coordinates.

Schema

address

LocationAddress { address1, address2, city, 3 more }

geo

GeoCoordinates { latitude, longitude }

Edit this pageorReport an issue

Fee

Configurable additional charge for products or payment methods

Stock Level

Per-variant inventory at a stock location