commerce/settings/locationUsages

Use the Location Usages resource to define the locations and location types that interact with the specified site. The system creates three default location usage types for each site after provisioning a new tenant - one for direct ship (DS), one for in-store pickup (SP), and one for store finder (storeFinder). Each site can only use a single location for the direct ship location usage type, and the location must support the direct ship fulfillment type (DS). For the in-store pickup location usage type, each site can use one or more location types. The location service identifies all locations of the specified type that support the in-store pickup fulfillment type (SP). For the store finder location usage type, each site can use one or more location types. The location service identifies all locations of the type. Locations configured for the store finder type do not typically maintain inventory. You cannot create additional location usage types at this time.

JSON Example

LocationUsage Properties

Property Description
locationCodes

type: list of string

List of location codes to associate with the location usage. At this time, you can only specify one location code in the request for the direct ship location usage type.

locationTypeCodes

type: list of string

List of location type codes associated with the location usage. The location service identifies the locations of the designated type. The in-store pickup (SP) and store finder (storeFinder) location usage types allow specification or multiple location type codes.

locationUsageTypeCode

type: string

The system-defined code used to identify the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder".

Operations

Operation Name Request URI Description
GetLocationUsage GET %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the location usages for the site specified in the request header.

GetLocationUsages GET %3fresponseFields%3d%7bresponseFields%7d

Retrieves the configured site location usages for the location usage code specified in the request.

UpdateLocationUsage PUT %7bcode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the location usage for the site based on the location usage code specified in the request.