Locations

Get the list of Locations

Path

GET /odata/Locations

Description

Returns the paged list of the existing Locations within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).

Note

This endpoint does not support logical operators (and, or, in, gt, ge, lt, le) for data filtering.

Request parameters

Parameter	Explanation
api-version: string default: 1.0 in header	The requested API version.
$search: string in query	Picks the value in all possible fields.
$filter: string in query	Filters the results, based on a Boolean condition.
$orderby: string in query	Sorts the results.
$top: string in query	Returns only the first n results.
$skip: string in query	Skips the first n results.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request	The limit for the `$top` query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
locationId: string (uuid)	Unique Identifier of the Location
locationNo: string	Identification Number of the Location
locationName: string	Name of the Location
facilityId: string (uuid)	Unique Identifier of the Facility
facilityNo: string	Identification Number of the Facility
facilityName: string	Name of the Facility
defaultBillingAddressId: string (uuid)	Unique Identifier of the Default Address for billing purposes
defaultBillingAddressNo: string	Identification Number of the Default Address for billing purposes
defaultBillingAddressName: string	Name of the Default Address for billing purposes
defaultShippingAddressId: string (uuid)	Unique Identifier of the Default Address for shipping purposes
defaultShippingAddressNo: string	Identification Number of the Default Address for shipping purposes
defaultShippingAddressName: string	Name of the Default Address for shipping purposes
glCode: string	General Ledger Code
activeStatus: boolean	Is the Location active or not?
defaultSyncFlag: boolean	Is Inventory Location marked with Default Synchronization Flag or not?
dateCreated: string (date-time)	Date when the Location was added
createdBy: string (uuid)	Unique Identifier of the user who added the Location
createdByName: string	Name of the user who added Location
lastUpdated: string (date-time)	Last Date when the Location was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the Location
lastUpdatedByName: string	Name of the last user who updated the Location

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)

{
  "items": [
    {
      "locationId": "00000000-0000-0000-0000-000000000000",
      "locationNo": "string",
      "locationName": "string",
      "facilityId": "00000000-0000-0000-0000-000000000000",
      "facilityNo": "string",
      "facilityName": "string",
      "defaultBillingAddressId": "00000000-0000-0000-0000-000000000000",
      "defaultBillingAddressNo": "string",
      "defaultBillingAddressName": "string",
      "defaultShippingAddressId": "00000000-0000-0000-0000-000000000000",
      "defaultShippingAddressNo": "string",
      "defaultShippingAddressName": "string",
      "glCode": "string",
      "activeStatus": "boolean",
      "defaultSyncFlag": "boolean",
      "dateCreated": "string (date-time)",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdByName": "string",
      "lastUpdated": "string (date-time)",
      "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
      "lastUpdatedByName": "string"
    }
  ],
  "nextPageLink": "string",
  "count": "integer (int64)"
}

Get the specified Location