Skip to main content
GET
/
commerce
/
admin
/
locationGroupConfiguration
/
location
/
{locationCode}
Error
A valid request URL is required to generate request examples
{
  "allowReturns": true,
  "attributes": [
    {
      "attributeDefinition": {
        "attributeCode": "<string>",
        "displayGroup": "<string>",
        "valueType": "<string>",
        "adminName": "<string>",
        "attributeFQN": "<string>",
        "attributeMetadata": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "auditInfo": {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z"
        },
        "availableForDiscounts": true,
        "availableForOrderRouting": true,
        "content": {
          "localeCode": "<string>",
          "value": "<string>"
        },
        "dataType": "<string>",
        "id": 123,
        "inputType": "<string>",
        "isActive": true,
        "isMultiValued": true,
        "isReadOnly": true,
        "isRequired": true,
        "isVisible": true,
        "namespace": "<string>",
        "order": 123,
        "validation": {
          "maxDateTime": "2023-11-07T05:31:56Z",
          "maxNumericValue": 123,
          "maxStringLength": 123,
          "minDateTime": "2023-11-07T05:31:56Z",
          "minNumericValue": 123,
          "minStringLength": 123,
          "regularExpression": "<string>"
        },
        "vocabularyValues": [
          {
            "value": "<string>",
            "content": {
              "localeCode": "<string>",
              "value": "<string>"
            },
            "isHidden": true,
            "sequence": 123
          }
        ]
      },
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "autoPackingListPopup": true,
  "blockPartialCancel": true,
  "blockPartialStock": true,
  "boxTypes": [
    {
      "height": 123,
      "length": 123,
      "name": "<string>",
      "width": 123
    }
  ],
  "bpmConfigurations": [
    {
      "shipmentType": "<string>",
      "workflowContainerId": "<string>",
      "workflowProcessId": "<string>"
    }
  ],
  "carriers": [
    {
      "carrierType": "<string>",
      "enableMultiPieceShipment": true,
      "features": [
        "<string>"
      ],
      "isEnabled": true,
      "shippingMethodMappings": {
        "enableSmartPost": true,
        "express1DayDefault": "<string>",
        "express2DayDefault": "<string>",
        "express3DayDefault": "<string>",
        "internationalUsReturnLabelShippingMethod": "<string>",
        "requireSignatureAmount": 123,
        "returnLabelShippingMethod": "<string>",
        "shippingMethods": [
          "<string>"
        ],
        "signatureOption": "<string>",
        "standardDefault": "<string>",
        "useDeclaredValue": true
      }
    }
  ],
  "closePickWavePermissions": [
    "<string>"
  ],
  "customerFailedToPickupAfterAction": "<string>",
  "customerFailedToPickupDeadline": 123,
  "defaultCarrier": "<string>",
  "defaultMaxNumberOfShipmentsInPickWave": 123,
  "defaultNumberOfOrdersInPickWave": 123,
  "defaultPrinterType": "<string>",
  "defaultReturnCarrier": "<string>",
  "defaultReturnRefundReductionAmount": 123,
  "displayProductImagesInPickWaveDetails": true,
  "enableAdvancedOptionForPickWaveCreation": true,
  "enableForISPU": true,
  "enableForSTH": true,
  "enablePnp": true,
  "enablePnpForBOPIS": true,
  "enablePnpForDelivery": true,
  "enablePnpForSTH": true,
  "enableScanningOfUpcForShipToHome": true,
  "locationGroupCode": "<string>",
  "locationGroupId": 123,
  "maxNumberOfPackingSlipsByGroup": 123,
  "maximumNumberOfOrdersInPickWave": 123,
  "maximumReturnRefundReductionAmount": 123,
  "packageSettings": {
    "unitType": "<string>"
  },
  "pickWavePrintFormat": "<string>",
  "printReturnLabel": true,
  "returnRefundReduction": true,
  "sendCustomerPickupReminder": 123,
  "siteId": 123,
  "slaConfigurations": [
    {
      "isEnabled": true,
      "slaId": 123,
      "targetServiceLevelPercentage": 123
    }
  ],
  "tenantId": 123,
  "wmsEnabled": true
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

locationCode
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

allowReturns
boolean | null
attributes
object[] | null
auditInfo
object
autoPackingListPopup
boolean | null
blockPartialCancel
boolean | null
blockPartialStock
boolean | null
boxTypes
object[] | null
bpmConfigurations
object[] | null
carriers
object[] | null
closePickWavePermissions
string[] | null
customerFailedToPickupAfterAction
string | null
customerFailedToPickupDeadline
integer<int32> | null
defaultCarrier
string | null
defaultMaxNumberOfShipmentsInPickWave
integer<int32> | null
defaultNumberOfOrdersInPickWave
integer<int32> | null
defaultPrinterType
string | null
defaultReturnCarrier
string | null
defaultReturnRefundReductionAmount
integer<int32> | null
displayProductImagesInPickWaveDetails
boolean | null
enableAdvancedOptionForPickWaveCreation
boolean | null
enableForISPU
boolean | null
enableForSTH
boolean | null
enablePnp
boolean | null
enablePnpForBOPIS
boolean | null
enablePnpForDelivery
boolean | null
enablePnpForSTH
boolean | null
enableScanningOfUpcForShipToHome
boolean | null
locationGroupCode
string | null
locationGroupId
integer<int32>
maxNumberOfPackingSlipsByGroup
integer<int32> | null
maximumNumberOfOrdersInPickWave
integer<int32> | null
maximumReturnRefundReductionAmount
integer<int32> | null
packageSettings
object
pickWavePrintFormat
string | null
printReturnLabel
boolean | null
returnRefundReduction
boolean | null
sendCustomerPickupReminder
integer<int32> | null
siteId
integer<int32>
slaConfigurations
object[] | null
tenantId
integer<int32>
wmsEnabled
boolean | null