Get In Store Pickup Location

Get a specific in store pickup Location for the Site. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error.

GET /commerce/storefront/locationUsageTypes/SP/locations/{locationCode}

Error

A valid request URL is required to generate request examples

200

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

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

locationCode · string · required

Query Parameters

includeAttributeDefinition · boolean · default: false

Include the location attributes associated definition

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

address · object

Show child attributes

allowFulfillmentWithNoStock · boolean

attributes · object[] | null

Show child attributes

auditInfo · object

Show child attributes

capacity · object

Show child attributes

code · string | null

cutoffTimes · object

Show child attributes

deliveryConsolidation · boolean

description · string | null

dropShip · object

Show child attributes

express · boolean

fax · string | null

fulfillmentTypes · object[] | null

Show child attributes

geo · object

Show child attributes

includeInInventoryAggregrate · boolean

includeInLocationExport · boolean

isDisabled · boolean

locationTypes · object[] | null

Show child attributes

name · string | null

note · string | null

phone · string | null

processingTimes · object

Show child attributes

regularHours · object

Show child attributes

requiresManifest · boolean

shipToHomeConsolidation · boolean

shippingOriginContact · object

Show child attributes

slaConfigurations · object[] | null

Show child attributes

supportsInventory · boolean

tags · string[] | null

transferEnabled · boolean

warehouseEnabled · boolean