GET v1/location/{locationID}/rule/detail

Retrieve detailed information about a specific Location Rule by location

Request Information

URI Parameters

Name	Description	Type	Additional information
locationID		integer	Required

Body Parameters

None.

Response Information

Resource Description

LocationRuleModel

Name	Description	Type	Additional information
LocationRuleID	Unique identifier of a Location Rule	integer	None.
ShipMethod	Ship method used at the location	ShipMethodModel	None.
IsLocked	Indicates location activity is locked	boolean	None.
CanSelfOrder	Indicates location can self-order on rentals	boolean	None.
AdditionalBillingDays	Number of additional billing days included before late fees apply	integer	None.
AllowUDFAddress	Denotes whether location has a single physical address, or is able to change address when selecting.	boolean	None.
PalletLabelQuantity	Number of pallet labels to print	integer	None.
ReturnFlagType		FlagTypeModel	None.
ReturnFlagBarcodePrefix		string	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
}