Sales | Customer Locations
Retrieve a list of locations related to the customer specified in the url parameter.
You can only access customers of your provider entity.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the locations.
Filter the result by searching for name
Parameters according to which a location can be sorted.
Order in which the result of a list request is sorted.
Specifies the index of the first item to return
0Specifies the maximum number of items to return (min: 1; max: 1000)
100OK: The requested locations.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested customer could not be found.
GET /v1/sales/customers/{customerId}/locations HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"previous": {
"href": "text",
"method": "text"
},
"next": {
"href": "text",
"method": "text"
},
"items": [
{
"created": "2026-01-01T00:00:00.000Z",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"managers": [
{
"managerPolicy": "text",
"id": 1,
"firstName": "Pierce",
"lastName": "Bell",
"fullName": "text",
"email": "p.bell@foo.io",
"username": "j.doe@foo.inc",
"costCenter": "4645-2343",
"costCenterId": 1,
"self": {
"href": "text",
"method": "text"
}
}
],
"metadataItems": [
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
],
"costCenter": {
"description": "text",
"id": 1,
"code": "text",
"self": {
"href": "text",
"method": "text"
}
},
"id": 1,
"name": "HQ New York",
"type": "location",
"self": {
"href": "text",
"method": "text"
}
}
],
"total": 1,
"self": {
"href": "text",
"method": "text"
}
}The location will be related to the customer given in the url parameter.
You can only create locations for customers of your provider entity.
Creating an office location will also create a warehouse location with the same name and address.
If you have activated "system products/services" for your provider tenant, an instance of the "Site Management" system service will be added to the customer's approval cart.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the location.
The name of the location.
foo Inc.Location cost center
Created: The created location.
The date and time the data record was created.
The identifier of the company location.
1The name of the company location.
HQ New YorkThe type of location.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
POST /v1/sales/customers/{customerId}/locations HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 360
{
"name": "foo Inc.",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234"
},
"managers": [
{
"employeeId": 1,
"role": "location-executive"
}
],
"costCenterId": 1
}{
"created": "2026-01-01T00:00:00.000Z",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"managers": [
{
"managerPolicy": "text",
"id": 1,
"firstName": "Pierce",
"lastName": "Bell",
"fullName": "text",
"email": "p.bell@foo.io",
"username": "j.doe@foo.inc",
"costCenter": "4645-2343",
"costCenterId": 1,
"self": {
"href": "text",
"method": "text"
}
}
],
"metadataItems": [
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
],
"costCenter": {
"description": "text",
"id": 1,
"code": "text",
"self": {
"href": "text",
"method": "text"
}
},
"id": 1,
"name": "HQ New York",
"type": "location",
"self": {
"href": "text",
"method": "text"
}
}The requested location must be related to the customer given in the url parameter otherwise it can not be found.
You can only access locations of customers of your provider entity.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the location.
The identifier of the location.
OK: The requested location.
The date and time the data record was created.
The identifier of the company location.
1The name of the company location.
HQ New YorkThe type of location.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
GET /v1/sales/customers/{customerId}/locations/{locationId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"created": "2026-01-01T00:00:00.000Z",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"managers": [
{
"managerPolicy": "text",
"id": 1,
"firstName": "Pierce",
"lastName": "Bell",
"fullName": "text",
"email": "p.bell@foo.io",
"username": "j.doe@foo.inc",
"costCenter": "4645-2343",
"costCenterId": 1,
"self": {
"href": "text",
"method": "text"
}
}
],
"metadataItems": [
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
],
"costCenter": {
"description": "text",
"id": 1,
"code": "text",
"self": {
"href": "text",
"method": "text"
}
},
"id": 1,
"name": "HQ New York",
"type": "location",
"self": {
"href": "text",
"method": "text"
}
}Overwrites all existing data with that from the request body.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the location.
The identifier of the location to be updated.
The name of the location.
foo Inc.Location Cost Center
NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
PUT /v1/sales/customers/{customerId}/locations/{locationId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 372
{
"name": "foo Inc.",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234"
},
"managers": [
{
"employeeId": 1,
"role": "location-manager"
}
],
"addressId": 1,
"costCenterId": 1
}No content
Deletes the location entity with its instance in the approval cart.
The delete operation can only be executed as long as the related system service instance is not ordered nor processed and there are no other relations depending on the location (e.g. employees).
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the location.
The identifier of the location to be deleted.
NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
Conflict: The location has relations due to which the deletion operation cannot be executed.
DELETE /v1/sales/customers/{customerId}/locations/{locationId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
trueNo Content
No content
Bad Request
Unauthorized
Forbidden
Not Found
PATCH /v1/sales/customers/{customerId}/locations/{locationId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 887
[
{
"op": "add",
"path": "/name",
"value": "foo Inc."
},
{
"op": "add",
"path": "/address/line1",
"value": "equipme GmbH"
},
{
"op": "add",
"path": "/address/street",
"value": "W 55th St"
},
{
"op": "add",
"path": "/address/number",
"value": "240"
},
{
"op": "add",
"path": "/address/addition",
"value": "3rd floor"
},
{
"op": "add",
"path": "/address/city",
"value": "New York"
},
{
"op": "add",
"path": "/address/postalCode",
"value": "10019"
},
{
"op": "add",
"path": "/address/countryCode",
"value": "US"
},
{
"op": "add",
"path": "/address/regionCode",
"value": "NY"
},
{
"op": "add",
"path": "/address/regionName",
"value": "New York"
},
{
"op": "add",
"path": "/address/dependentLocality",
"value": "Chilmington Green"
},
{
"op": "add",
"path": "/address/phoneNumber",
"value": "+1 212-555-1234"
},
{
"op": "add",
"path": "/managers/-",
"value": {
"employeeId": 1,
"role": "location-manager"
}
},
{
"op": "add",
"path": "/managers/0",
"value": {}
},
{
"op": "add",
"path": "/costCenterId",
"value": 123
}
]No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Ok
No content
Created
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
GET /v1/sales/customers/{customerId}/locations/{locationId}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
DTO for creating a new metadata entry for a given resource which implements the logic
Key for the new metadata entry
Metadata value
Created: The created metadata entry.
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
POST /v1/sales/customers/{customerId}/locations/{locationId}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"key": "text",
"value": "text"
}{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Ok
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
GET /v1/sales/customers/{customerId}/locations/{locationId}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
NoContent
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
DELETE /v1/sales/customers/{customerId}/locations/{locationId}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Customer data scope
OK
Bad Request
Unauthorized
Forbidden
Not Found
POST /v1/sales/customers/{customerId}/locations/search HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 152
{
"metadataScope": "Supplier",
"metaDataFilter": [
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
]
}{
"previous": {
"href": "text",
"method": "text"
},
"next": {
"href": "text",
"method": "text"
},
"items": [
{
"created": "2026-01-01T00:00:00.000Z",
"address": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"managers": [
{
"managerPolicy": "text",
"id": 1,
"firstName": "Pierce",
"lastName": "Bell",
"fullName": "text",
"email": "p.bell@foo.io",
"username": "j.doe@foo.inc",
"costCenter": "4645-2343",
"costCenterId": 1,
"self": {
"href": "text",
"method": "text"
}
}
],
"metadataItems": [
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
],
"costCenter": {
"description": "text",
"id": 1,
"code": "text",
"self": {
"href": "text",
"method": "text"
}
},
"id": 1,
"name": "HQ New York",
"type": "location",
"self": {
"href": "text",
"method": "text"
}
}
],
"total": 1,
"self": {
"href": "text",
"method": "text"
}
}Last updated
Was this helpful?