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

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

locationGroupCode
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

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

Response

Success

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