XOMNI: Experience Omni-Channel

Logical Device API set

Unregistering a logical device to a specific physical device

HTTP DELETE /company/logicaldevices/{deviceId}

This API enables a client application to unregister a logical device to a specific physical device which is represented through the header of the request.

Fetching a List of Logical Devices in the Nearest Store Using Location

HTTP GET /company/stores/{GPSLocation}/logicaldevices?searchDistance={searchDistance}&deviceTypeId={deviceTypeId}&metadataKey={metadataKey}&metadataValue={metadataValue}&includeMetadata={includeMetadata}

This API allows a client application to fetch a list of logical devices in the nearest store based on the given location with device type and metadata key-value based filtering option.

Fetching a List of Logical Devices in the Nearest Store Using Physical Device

HTTP GET /company/stores/logicaldevices?deviceTypeId={deviceTypeId}&metadataKey={metadataKey}&metadataValue={metadataValue}&includeMetadata={includeMetadata}

This API allows a client application to fetch a list of logical devices in a store which the physical device, retrieved through the OAuth Token, is assigned to with device type and metadata key-value based filtering option.

Updating the particular logical device info

HTTP PATCH /company/logicaldevices/{deviceId}

This API enables the client to update the specific logical device information through an HTTP PATCH request. You can omit the fields of the request body as you are using the PATCH HTTP method.

Registering a logical device to a specific physical device

HTTP POST /company/logicaldevices

This API enables a client application to assign a logical device information to a specific physical device which is represented through the header of the request.

Fetching a logical device detail by ID

HTTP GET /company/logicaldevices/{deviceId}

This API enables a client application to fetc a logical device details by ID.