Skip to main content
PATCH
Update a location
Requires permission:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string
required

A location's uuid or syncId.

Body

application/json

A partial update — only the fields you send change. ownerCompany is immutable after create and is not accepted here.

name
string
type
enum<string>
Available options:
factory,
warehouse,
office,
port,
other
address1
string
address2
string
postCode
string
city
string
state
string
country
string
geoLocation
object

A geolocation reference to anchor the site, or null to detach the current point.

Response

The updated location

A named company site (factory / warehouse / office / port / other), optionally anchored to a geolocation for coordinates. Products, activities, and transport legs reference these internally as a physical origin / destination / location.

uuid
string<uuid>
name
string
Example:

"Tokyo factory"

type
enum<string>
Available options:
factory,
warehouse,
office,
port,
other
Example:

"factory"

owner
object

The company that owns the site — your own company, or an unclaimed supplier you registered it for.

address1
string
Example:

"1-1 Marunouchi"

address2
string
postCode
string
Example:

"100-0005"

city
string
Example:

"Tokyo"

state
string
country
string
Example:

"Japan"

geoLocation
object