Update Locations | BigCommerce Developer Center

Update existing locations.

Limits

Limit of 50 concurrent requests.
Limit of 100 active locations.

Update existing locations. **Limits** * Limit of 50 concurrent requests. * Limit of 100 active locations.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Locations	read-only	`store_locations_read_only`
Store Locations	modify	`store_locations`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Store Locations | read-only | `store_locations_read_only` | | Store Locations | modify | `store_locations` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

idintegerRequired

Location immutable unique identifier.

codestringOptional

Location user-defined unique identifier.

labelstringOptional

Location label.

descriptionstringOptional

Description of location.

managed_by_external_sourcebooleanOptionalDefaults to false

Indicates if the third-party system is the source of truth for inventory values. If set to true, manually editing inventory in BCʼs control panel will be disabled.

type_idenumOptionalDefaults to PHYSICAL

Describe type of given location.

Allowed values:

enabledbooleanOptionalDefaults to true

Indicator of accessibility of the location.

operating_hoursobjectOptional

Schedule with opening and closing hours for each day of the week.

time_zonestringOptional

Time zone of location.

addressobjectOptional

storefront_visibilitybooleanOptionalDefaults to true

Indicator of accessibility of location on the storefront.

special_hourslist of objectsOptional

Response

The request has been successfully processed.

transaction_idstring

Unique identifier of performed action.

Errors

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations"
4
5	payload = [
6	{
7	"id": 2,
8	"code": "BIGC-2",
9	"label": "Central store",
10	"description": "Central shop of the world",
11	"managed_by_external_source": False,
12	"type_id": "PHYSICAL",
13	"enabled": True,
14	"operating_hours": {
15	"sunday": {
16	"open": False,
17	"opening": "08:00",
18	"closing": "16:00"
19	},
20	"monday": {
21	"open": False,
22	"opening": "08:00",
23	"closing": "16:00"
24	},
25	"tuesday": {
26	"open": False,
27	"opening": "08:00",
28	"closing": "16:00"
29	},
30	"wednesday": {
31	"open": False,
32	"opening": "08:00",
33	"closing": "16:00"
34	},
35	"thursday": {
36	"open": False,
37	"opening": "08:00",
38	"closing": "16:00"
39	},
40	"friday": {
41	"open": False,
42	"opening": "08:00",
43	"closing": "16:00"
44	},
45	"saturday": {
46	"open": False,
47	"opening": "08:00",
48	"closing": "16:00"
49	}
50	},
51	"time_zone": "Etc/UTC",
52	"address": {
53	"country_code": "US",
54	"address1": "5th Ave",
55	"address2": "string",
56	"city": "New York City",
57	"state": "NY",
58	"zip": "12345",
59	"email": "test@example.com",
60	"phone": "800-555-0198",
61	"geo_coordinates": {
62	"latitude": 11,
63	"longitude": 11
64	}
65	},
66	"storefront_visibility": True,
67	"special_hours": [
68	{
69	"label": "Thanksgiving",
70	"date": "2022-09-29",
71	"open": True,
72	"opening": "09:00",
73	"closing": "09:00",
74	"all_day": False,
75	"annual": False
76	}
77	]
78	}
79	]
80	headers = {
81	"X-Auth-Token": "<apiKey>",
82	"Content-Type": "application/json"
83	}
84
85	response = requests.put(url, json=payload, headers=headers)
86
87	print(response.json())

1	{
2	"transaction_id": "string"
3	}