POST public-api/locations/create
This method creates a new location. The existing location is retrieved by calling one of the searches. It requires the Create Location permission and access to the Site where the Location is being created. It accepts a maximum of 500 records at a time. Response Information not display BatchNumber if it's null .
Request Information
URI Parameters
None.
Body Parameters
Collection of LocationModelInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| RowNumber | integer |
None. |
|
| SiteName | string |
None. |
|
| ZoneName | string |
None. |
|
| LocationCode | string |
None. |
|
| LocationDescription | string |
None. |
|
| UsageTypeName | string |
None. |
|
| LocationSaleable | integer |
None. |
|
| DefaultLocation | boolean |
None. |
|
| LocationRecordStatus | RecordStatus |
None. |
|
| LocationNotes | string |
None. |
|
| AllLocationNotes | Collection of NoteInfo |
None. |
|
| CustomFields | Collection of DcfValueInfo |
None. |
|
| LocationSequence | decimal number |
None. |
|
| LocationWidth | decimal number |
None. |
|
| LocationHeight | decimal number |
None. |
|
| LocationDepth | decimal number |
None. |
|
| DimensionUnit | string |
None. |
|
| LocationVolume | decimal number |
None. |
|
| LocationMaxWeight | decimal number |
None. |
|
| WeightUnit | string |
None. |
|
| LocationMaxVolume | decimal number |
None. |
|
| VolumeUnit | string |
None. |
|
| ParentLocation | string |
None. |
|
| ChildrenLocations | integer |
None. |
|
| LastUpdated | date |
None. |
Request Formats
application/json
Sample:
[
{
"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-25T02:25:30.7124527+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-07-25T02:25:30.7124527+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-25T02:25:30.7124527+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-07-25T02:25:30.7124527+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-25T02:25:30.7124527+00:00"
},
{
"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-25T02:25:30.7124527+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-07-25T02:25:30.7124527+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-25T02:25:30.7124527+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-07-25T02:25:30.7124527+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-25T02:25:30.7124527+00:00"
}
]
Response Information
Resource Description
WaspResultOfResults| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Results |
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": {
"ResultList": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"SuccessfullResults": 1,
"TotalResults": 2,
"ErrorCount": 0
},
"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
}