POST public-api/locations/getlocationsbycode

This method returns existing locations by name. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL. It requires the Allow Location permission and access to the Site where the Location is located.

Request Information

URI Parameters

None.

Body Parameters

Collection of LocationCodeWithSiteName

Name	Description	Type	Additional information
LocationCode		string	None.
SiteName		string	None.

Request Formats

application/json

Sample:

[
  {
    "LocationCode": "sample string 1",
    "SiteName": "sample string 2"
  },
  {
    "LocationCode": "sample string 1",
    "SiteName": "sample string 2"
  }
]

Response Information

Resource Description

WaspResultOfListOfWaspResultOfLocationModelInfo

Name	Type	Additional information
Data	Collection of WaspResultOfLocationModelInfo	None.
Messages	Collection of WtResult	None.
BatchNumber	integer	None.
HasError	boolean	None.
HasHttpError	boolean	None.
HasMessage	boolean	None.
HasSuccessWithMoreDataRemaining	boolean	None.
TotalRecordsLongCount	integer	None.

Response Formats

application/json

Sample:

{
  "Data": [
    {
      "Data": {
        "RowNumber": 1,
        "SiteName": "sample string 2",
        "ZoneName": "sample string 3",
        "LocationCode": "sample string 4",
        "LocationDescription": "sample string 5",
        "UsageTypeName": "sample string 6",
        "LocationSaleable": 1,
        "DefaultLocation": true,
        "LocationRecordStatus": 0,
        "LocationNotes": "sample string 7",
        "AllLocationNotes": [
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-26T01:06:19.7317906+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-26T01:06:19.7317906+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-26T01:06:19.7317906+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-26T01:06:19.7317906+00:00",
            "DcfValueRecordStatus": 0
          }
        ],
        "LocationSequence": 1.0,
        "LocationWidth": 1.0,
        "LocationHeight": 1.0,
        "LocationDepth": 1.0,
        "DimensionUnit": "sample string 8",
        "LocationVolume": 1.0,
        "LocationMaxWeight": 1.0,
        "WeightUnit": "sample string 9",
        "LocationMaxVolume": 1.0,
        "VolumeUnit": "sample string 10",
        "ParentLocation": "sample string 11",
        "ChildrenLocations": 12,
        "LastUpdated": "2026-07-26T01:06:19.7317906+00:00"
      },
      "Messages": [
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        },
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        }
      ],
      "BatchNumber": 1,
      "HasError": false,
      "HasHttpError": false,
      "HasMessage": true,
      "HasSuccessWithMoreDataRemaining": false,
      "TotalRecordsLongCount": 1
    },
    {
      "Data": {
        "RowNumber": 1,
        "SiteName": "sample string 2",
        "ZoneName": "sample string 3",
        "LocationCode": "sample string 4",
        "LocationDescription": "sample string 5",
        "UsageTypeName": "sample string 6",
        "LocationSaleable": 1,
        "DefaultLocation": true,
        "LocationRecordStatus": 0,
        "LocationNotes": "sample string 7",
        "AllLocationNotes": [
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-26T01:06:19.7317906+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-26T01:06:19.7317906+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-26T01:06:19.7317906+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-26T01:06:19.7317906+00:00",
            "DcfValueRecordStatus": 0
          }
        ],
        "LocationSequence": 1.0,
        "LocationWidth": 1.0,
        "LocationHeight": 1.0,
        "LocationDepth": 1.0,
        "DimensionUnit": "sample string 8",
        "LocationVolume": 1.0,
        "LocationMaxWeight": 1.0,
        "WeightUnit": "sample string 9",
        "LocationMaxVolume": 1.0,
        "VolumeUnit": "sample string 10",
        "ParentLocation": "sample string 11",
        "ChildrenLocations": 12,
        "LastUpdated": "2026-07-26T01:06:19.7317906+00:00"
      },
      "Messages": [
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        },
        {
          "ResultCode": 0,
          "Message": "sample string 1",
          "HttpStatusCode": 200,
          "FieldName": "sample string 2"
        }
      ],
      "BatchNumber": 1,
      "HasError": false,
      "HasHttpError": false,
      "HasMessage": true,
      "HasSuccessWithMoreDataRemaining": false,
      "TotalRecordsLongCount": 1
    }
  ],
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}