Invendor Locations API

The Locations API from Invendor — 21 operation(s) for locations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Invendor Locations API is one of 42 APIs that Invendor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Locations. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 31 operations across 21 paths, and defines 47 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against the base URL https://api.invendor.com.

31 operations 21 paths 47 schemas 4 DELETE15 GET6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

1.0

Base URL

https://api.invendor.com

Authentication

OAuth 2.0

Resource Areas

Authentication & Security 1

Invendor Locations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 31

Across 21 paths, the API surfaces 31 operations — 4 DELETE, 15 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Locations 31

GET

/v1/Locations

Get all locations

GetAllLocations 8 params → 200400401403

POST

/v1/Locations

Create a new locations

Create location 1 param body → 201400422401403

GET

/v1/Locations/{serviceId}

Get service locations

Get service locations 9 params → 200400401403

GET

/v1/Locations/{id}

Get location details

Get locations details 2 params → 200400401403

PUT

/v1/Locations/{locationId}

Update location details

Update locations details 2 params body → 204400422401403

DELETE

/v1/Locations/{locationId}

Delete location

Delete location 2 params → 204400422401403

GET

/v1/Locations/{locationId}/order-notifications

Get order notification settings for location (buyer side)

Get location order notification settings 2 params → 200400401403

PUT

/v1/Locations/{locationId}/order-notifications

Update order notification settings for location (buyer side)

Update location order notification settings 2 params body → 200400401403

GET

/v1/Locations/{locationId}/accounts/{accountId}/order-notifications

Get order notification settings for a vendor account at this location

Get vendor order notification settings 2 params → 200400401403

PUT

/v1/Locations/{locationId}/accounts/{accountId}/order-notifications

Update order notification settings for a vendor account at this location

Update vendor order notification settings 2 params body → 200400401403

GET

/v1/Locations/{locationId}/vendors

Get all vendor accounts for a location

Get location vendors 2 params → 200400401403

POST

/v1/Locations/{locationId}/vendors

Add a vendor account to the location

Add vendor to location 2 params body → 200400401403

PUT

/v1/Locations/{locationId}/vendors/{accountIdToUpdate}

Update vendor order notification settings

Update vendor notification settings 3 params body → 200400401403

DELETE

/v1/Locations/{locationId}/vendors/{accountIdToRemove}

Remove vendor account from location

Remove vendor from location 3 params → 200400401403

GET

/v1/Locations/{locationId}/customers

Get all customer accounts for a location

Get location customers 2 params → 200400401403

PUT

/v1/Locations/{locationId}/customers

Upsert customer accounts for a location

Upsert location customers 2 params body → 200400401403

GET

/v1/Locations/{locationId}/groups

Get location groups related to current user

User groups for user in selected location 2 params → 200400401403

GET

/v1/Locations/{locationId}/devices

Returns all devices linked to the location

LocationDevicesList 2 params → 200400401403

POST

/v1/Locations/{locationId}/devices

Link location and device

Add location device 2 params body → 204400401403

DELETE

/v1/Locations/{locationId}/devices/{deviceId}

Unlink device to the location

Remove location device 3 params → 204400401403

GET

/v1/Locations/{locationId}/locks

Returns all area locks in the location

GetLocationLocks 2 params → 200400401403

GET

/v1/Locations/{locationId}/locks/{wmsAreaId}

Returns all area locks for the given area in the location

GetAreaLocks 3 params → 200400401403

POST

/v1/Locations/{locationId}/locks/{wmsAreaId}

Save all area locks

SaveAreaLocks 3 params body → 200400401403

GET

/v1/Locations/properties

Get the list of all the properties added to locations

GetAllUsedLocationProperties 1 param → 200400401403

GET

/v1/Locations/definedProperties

Get the defined properties for locations

Get defined properties for locations 1 param → 200400401403

POST

/v1/Locations/definedProperties

Create new location property with parameters

Create location defined property with parameters 1 param body → 200400401403

PUT

/v1/Locations/definedProperties/{id}

Update existing location property with parameters

Update location defined property with parameters 2 params body → 200400401403

DELETE

/v1/Locations/definedProperties/{id}

Delete existing location property with parameters

Delete location defined propety with parameters 2 params → 200400401403

POST

/v1/Locations/definedProperties/bulk

Bulk upsert/delete location properties with parameters

Create or update location defined propeties with parameters 1 param body → 200400401403

GET

/v1/Locations/{locationId}/tenants

Get the list of all external tenants related to this location

GetAllTenants 2 params → 200400401403

GET

/v1/Locations/forCompany

Get company locations

Get account locations 8 params → 200400401403

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are LocationDetailsResponse (27 properties), Device (23 properties), UpdateLocationDetailsRequest (17 properties), DeviceHeartbeat (17 properties). Each schema is shown below with its type and property counts.

LocationResponse

object

9 properties

IDomainEvent

object

2 properties

CreateDefinedPropertyParametersRequest

object

5 properties

UpdateLocationDetailsRequest

object

17 properties

ClientTenantResponse

object

3 properties

DeviceEvent

object

5 properties

DeviceEventNotification

object

5 properties

CreateLocationRequest

object

15 properties

TenantDevice

object

3 properties

DeviceSIMStatus

object

6 properties

Device

object

23 properties

AreaLockResponse

object

7 properties

DeviceRegistrationState

object

9 properties

AddLocationDeviceRequest

object

1 property

VendorAccountResponse

object

8 properties

CabinetProdData

object

8 properties

OrderNotificationSettingsRequest

object

4 properties

GetDefinedPropertyParametersResponse

object

7 properties

DeviceShelfStatus

object

10 properties

Error

object

2 properties

CabinetType

integer

OrderNotificationSettingsResponse

object

4 properties

DeviceHeartbeat

object

17 properties

DeviceType

integer

DeviceHeartbeatUserInfo

object

9 properties

LocationType

integer

LocationDetailsResponse

object

27 properties

OperationResponse

object

7 properties

LocationResponsePagedResult

object

5 properties

LocationConsumptionType

integer

OperationType

integer

UpdateDefinedPropertyParametersRequest

object

6 properties

LocationAreaLocksResponse

object

3 properties

Int32ResourceCreatedResponse

object

1 property

OrderNotificationAttachmentFormat

integer

DevicePreRegistrationStatus

integer

AddVendorAccountRequest

object

5 properties

BulkUpsertDefinedPropertyParametersRequest

object

6 properties

DeviceResponse

object

16 properties

UserProfileResponse

object

5 properties

CustomerAccountResponse

object

4 properties

ExtendedPropertyAffinity

integer

ApiErrorResponse

object

1 property

OrderStatus

integer

NotificationsReceiver

object

5 properties

DefinedPropertyValueDTO

object

2 properties

AreaLockRequest

object

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Invendor publishes across the network.

Invendor Accounts API

AE Profile APIs.io

Invendor Auth API

AE Profile APIs.io

Invendor Barcodes API

AE Profile APIs.io

Invendor Consumption API

AE Profile APIs.io

Invendor DataJobs API

AE Profile APIs.io

Invendor Devices API

AE Profile APIs.io

Invendor Dimensions API

AE Profile APIs.io

Invendor DimensionValues API

AE Profile APIs.io

Invendor Doors API

AE Profile APIs.io

Invendor DynamicScanContent API

AE Profile APIs.io

Invendor ExtendedProperties API

AE Profile APIs.io

Invendor FlagTypes API

AE Profile APIs.io

#Locations

← Back to I APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Invendor Locations API

Metadata

Authentication & Security 1

Paths & Operations 31

Schemas 47

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Invendor Locations API

Metadata

Authentication & Security 1

Paths & Operations 31

Schemas 47

Specification

Source

More from Invendor 12

API Details

Provider

Explore more