Skip to main content
GET
/
commerce
/
admin
/
locations
/
{locationCode}
Error
A valid request URL is required to generate request examples
{
  "code": "<string>",
  "locationTypes": [
    {
      "code": "<string>",
      "name": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "address": {
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "cityOrTown": "<string>",
    "stateOrProvince": "<string>",
    "postalOrZipCode": "<string>",
    "countryCode": "<string>",
    "addressType": "<string>",
    "isValidated": true
  },
  "geo": {
    "lat": 123,
    "lng": 123
  },
  "phone": "<string>",
  "fax": "<string>",
  "supportsInventory": true,
  "fulfillmentTypes": [
    {
      "code": "<string>",
      "name": "<string>"
    }
  ],
  "regularHours": {
    "sunday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "monday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "tuesday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "wednesday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "thursday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "friday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "saturday": {
      "label": "<string>",
      "openTime": "<string>",
      "closeTime": "<string>",
      "isClosed": true
    },
    "timeZone": "<string>"
  },
  "cutoffTimes": {
    "timeZone": {
      "id": "<string>",
      "offset": 123,
      "isDaylightSavingsTime": true,
      "ianaCode": "<string>"
    },
    "schedules": [
      {
        "fulfillmentType": "<string>",
        "times": {
          "sunday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "monday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "tuesday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "wednesday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "thursday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "friday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          },
          "saturday": {
            "startTime": "<string>",
            "endTime": "<string>",
            "isClosed": true
          }
        }
      }
    ]
  },
  "shippingOriginContact": {
    "firstName": "<string>",
    "middleNameOrInitial": "<string>",
    "lastNameOrSurname": "<string>",
    "companyOrOrganization": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>"
  },
  "note": "<string>",
  "tags": [
    "<string>"
  ],
  "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>"
      ]
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "allowFulfillmentWithNoStock": true,
  "isDisabled": true,
  "express": true,
  "transferEnabled": true,
  "shipToHomeConsolidation": true,
  "deliveryConsolidation": true,
  "includeInInventoryAggregrate": true,
  "includeInLocationExport": true,
  "warehouseEnabled": true,
  "requiresManifest": true,
  "processingTimes": {
    "fulfillment": [
      {
        "fulfillmentTypeCode": "<string>",
        "unit": "<string>",
        "value": 123
      }
    ],
    "receive": {
      "unit": "<string>",
      "value": 123
    }
  },
  "slaConfigurations": [
    {
      "slaId": 123,
      "isEnabled": true,
      "targetServiceLevelPercentage": 123
    }
  ],
  "capacity": {
    "unitOfMeasure": "<string>",
    "shipmentsPerUnit": 123
  },
  "dropShip": {
    "vendorCode": "<string>"
  }
}

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

code
string | null
locationTypes
object[] | null
name
string | null
description
string | null
address
object
geo
object
phone
string | null
fax
string | null
supportsInventory
boolean
fulfillmentTypes
object[] | null
regularHours
object
cutoffTimes
object
shippingOriginContact
object
note
string | null
tags
string[] | null
attributes
object[] | null
auditInfo
object
allowFulfillmentWithNoStock
boolean
isDisabled
boolean
express
boolean
transferEnabled
boolean
shipToHomeConsolidation
boolean
deliveryConsolidation
boolean
includeInInventoryAggregrate
boolean
includeInLocationExport
boolean
warehouseEnabled
boolean
requiresManifest
boolean
processingTimes
object
slaConfigurations
object[] | null
capacity
object
dropShip
object