GET v1/locationZone/detail/{locationZoneID}

Retrieve detailed information about a specific Location Zone by unique identifier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationZoneID

integer

Required

Body Parameters

None.

Response Information

Resource Description

LocationZoneModel
NameDescriptionTypeAdditional information
LocationZoneID

Unique identifier of a Location Zone

integer

None.

Location

Location zone is associated with

LocationModel

None.

ZoneName

Zone Name

string

None.

LocationZoneCategory

Loading zone

LocationZoneCategoryModel

None.

OperationIDs

Comma delimited list of operation IDs

string

None.

ModuleFeatures

Collection of ModuleFeatureModel

None.

Response Formats

application/json, text/json

Sample:
{
  "locationZoneID": 1,
  "location": {
    "locationID": 1,
    "company": {
      "companyID": 1,
      "companyName": "sample string 2",
      "companyCode": "sample string 3",
      "vatNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "address4": "sample string 8",
      "address5": "sample string 9",
      "email": "sample string 10",
      "currentRates": [
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.6260404+00:00"
        },
        {
          "companyRateID": 1,
          "rate": 2.0,
          "supportLevel": {
            "supportLevelID": 1,
            "supportLevel": "sample string 2"
          },
          "startDate": "2025-11-08T08:24:32.6260404+00:00"
        }
      ]
    },
    "isActive": true,
    "isKeyAccount": true,
    "locationCategory": {
      "locationCategoryID": 1,
      "locationCategory": "sample string 2",
      "isSystem": true
    },
    "locationName": "sample string 4",
    "address": "sample string 5",
    "address2": "sample string 6",
    "address3": "sample string 7",
    "city": "sample string 8",
    "state": {
      "stateID": 1,
      "stateShortName": "sample string 2",
      "stateLongName": "sample string 3"
    },
    "zipCode": "sample string 9",
    "country": {
      "countryID": 1,
      "countryShortName": "sample string 2",
      "countryLongName": "sample string 3"
    },
    "cityStateZipCountry": "sample string 10",
    "xCoordinate": "sample string 11",
    "yCoordinate": "sample string 12",
    "googlePlaceID": "sample string 13",
    "googleURL": "sample string 14",
    "term": {
      "termID": 1,
      "term": "sample string 2",
      "isActive": true
    },
    "bolTemplate": {
      "bolTemplateID": 1,
      "templateName": "sample string 2"
    },
    "isIntegrationControlled": true,
    "locationRules": {
      "locationRuleID": 1,
      "shipMethod": {
        "shipMethodID": 1,
        "shipMethod": "sample string 2"
      },
      "isLocked": true,
      "canSelfOrder": true,
      "additionalBillingDays": 4,
      "allowUDFAddress": true,
      "palletLabelQuantity": 6,
      "returnFlagType": {
        "flagTypeID": 1,
        "flagType": "sample string 2",
        "isActive": true,
        "isSystem": true,
        "isCleared": true,
        "isDefault": true,
        "isRepair": true,
        "isAdmin": true,
        "isRepairComponent": true
      },
      "returnFlagBarcodePrefix": "sample string 7"
    }
  },
  "zoneName": "sample string 2",
  "locationZoneCategory": {
    "locationZoneCategoryID": 1,
    "locationZoneCategory": "sample string 2",
    "isActive": true,
    "isSystem": true
  },
  "operationIDs": "sample string 3",
  "moduleFeatures": [
    {
      "moduleFeatureID": 1,
      "module": {
        "moduleID": 1,
        "isCategoryFunction": true,
        "isIncluded": true,
        "moduleCategoryID": 4,
        "moduleCategory": "sample string 5",
        "moduleName": "sample string 6",
        "hasAccessType": true,
        "canWrite": true,
        "imageURL": "sample string 9",
        "routeName": "sample string 10",
        "apiRole": "sample string 11",
        "modifiedDate": "2025-11-08T08:24:32.6260404+00:00",
        "modifiedBy": "sample string 13"
      },
      "moduleFeature": "sample string 2",
      "isIncluded": true,
      "routeName": "sample string 4"
    },
    {
      "moduleFeatureID": 1,
      "module": {
        "moduleID": 1,
        "isCategoryFunction": true,
        "isIncluded": true,
        "moduleCategoryID": 4,
        "moduleCategory": "sample string 5",
        "moduleName": "sample string 6",
        "hasAccessType": true,
        "canWrite": true,
        "imageURL": "sample string 9",
        "routeName": "sample string 10",
        "apiRole": "sample string 11",
        "modifiedDate": "2025-11-08T08:24:32.6260404+00:00",
        "modifiedBy": "sample string 13"
      },
      "moduleFeature": "sample string 2",
      "isIncluded": true,
      "routeName": "sample string 4"
    }
  ]
}