InventoryLocations

Returns a list of Inventory Locations.

Table Specific Information

Select

The driver uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = and IN comparisons.
Code supports the = and IN comparisons.
TypeId supports the = and IN comparisons.
Enabled supports the = comparison.
StorefrontVisibility supports the = comparison.
ManagedByExternalSource supports the = comparison.

The rest of the filter is executed client-side within the driver.

For example, the following queries are processed server-side:

SELECT * FROM InventoryLocations WHERE Id = 1

SELECT * FROM InventoryLocations WHERE Code = 'WAREHOUSE1'

Insert

To insert an inventory location, specify at least the Code, TypeId, TimeZone, ManagedByExternalSource, and Label columns. Address is required when TypeId is PHYSICAL.

INSERT INTO InventoryLocations (Code, Label, TypeId, TimeZone, ManagedByExternalSource) VALUES ('NEW WAREHOUSE', 'Warehouse Shop', 'VIRTUAL', 'Etc/UTC', false)

Update

UPDATE InventoryLocations SET OperatingHoursSunday='{\"open\": false, \"opening\": \"08:00\", \"closing\": \"16:00\" }' WHERE Id = 2

Delete

The default location (Id = 1) cannot be deleted, nor can a location with open order transactions.

DELETE FROM InventoryLocations WHERE Id = 2

DELETE FROM InventoryLocations WHERE Id IN (2,3)

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique identifier of the location.
Code	String	False	A user-defined unique code identifying the location.
Label	String	False	The display name of the location.
Description	String	False	A description of the location.
TypeId	String	False	The type of location. Defaults to PHYSICAL. The allowed values are PHYSICAL, VIRTUAL.
Enabled	Boolean	False	Whether the location is active.
StorefrontVisibility	Boolean	False	Whether the location is visible on the storefront, for example for in-store pickup.
ManagedByExternalSource	Boolean	False	Whether the location's inventory is managed by an external source rather than BigCommerce.
TimeZone	String	False	The IANA time zone name of the location.
Address1	String	False	Main address information.
Address2	String	False	Additional address information.
City	String	False	The city where the location is located.
State	String	False	The state where the location is located.
Zip	String	False	Zip code of the location.
Email	String	False	Email of the location.
Phone	String	False	Phone number of the location.
CountryCode	String	False	ISO 3166-1 alpha-3 code.
GeoCoordinatesLatitude	Float	False	Latitude of the location.
GeoCoordinatesLongitude	Float	False	Longitude of the location.
OperatingHoursSunday	String	False	A JSON-formatted object describing the location's operating hours schedule for Sunday.
OperatingHoursMonday	String	False	A JSON-formatted object describing the location's operating hours schedule for Monday.
OperatingHoursTuesday	String	False	A JSON-formatted object describing the location's operating hours schedule for Tuesday.
OperatingHoursWednesday	String	False	A JSON-formatted object describing the location's operating hours schedule for Wednesday.
OperatingHoursThursday	String	False	A JSON-formatted object describing the location's operating hours schedule for Thursday.
OperatingHoursFriday	String	False	A JSON-formatted object describing the location's operating hours schedule for Friday.
OperatingHoursSaturday	String	False	A JSON-formatted object describing the location's operating hours schedule for Saturday.
SpecialHours	String	False	A JSON-formatted array of one-off special hours entries that override the regular operating hours.
CreatedAt	Datetime	True	Date and time the location was created.
UpdatedAt	Datetime	True	Date and time the location was last updated.