Locations
Get the list of Locations
Path
GET /odata/Locations
Description
Returns a paged list of existing Locations within the logged-in organization.
Note
You can filter the results as follows:
- For an exact match, use:
$filter parameter–entity eq ‘string’ - For a partial match, use:
$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 |
Searches across all supported fields. |
| $filter: string in query |
Filters results based on a Boolean condition. |
| $orderby: string in query |
Sorts 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 insert the access_token obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | The request contains incorrect input data. |
| 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 | The specified access_token is invalid or has expired. |
| 403 Forbidden | The user doesn’t have the appropriate privileges. |
| 500 Internal Server Error | The 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)
Response example (200 OK)
{
"@odata.context": "link",
"@odata.count": "number",
"value": [
{
"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"
}
],
"@odata.nextLink": "link"
}
Get the specified Location
Path
GET /odata/Locations({locationId})
Description
Returns the details of the Location specified by ID.
Request parameters
Parameter |
Explanation |
|---|---|
| locationId: string (uuid) required in path |
Enter the ID of the Location. |
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and insert the access_token obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | The request contains incorrect input data. |
| 401 Unauthorized | The specified access_token is invalid or has expired. |
| 403 Forbidden | The user doesn’t have the appropriate privileges. |
| 404 Not Found | The specified ID is absent in the system. |
| 500 Internal Server Error | The 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)
Response example (200 OK)
{
"@odata.context": "link",
"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"
}