Commerce

`createLocation`

Create Location

Create a shop's fulfillment location: the pickup/fulfillment anchor an order joins to.

write

Arguments

appIdstringrequiredThe Studio app ID to create the location under.
namestringrequiredLocation name (e.g. "Pure Pastry: Beverly").
timezonestringrequiredIANA timezone (e.g. "America/New_York") the hours are local to: required, slots are meaningless without it.
addressLine1stringoptionalStreet address line 1.
addressLine2stringoptionalStreet address line 2.
citystringoptionalCity.
regionstringoptionalState / region.
postalCodestringoptionalPostal code.
countrystringoptional2-letter ISO country code (e.g. US).
placementobjectoptionalWhere this location surfaces on the storefront. Defaults to shown-in-hours only.
supportedFulfillmentobjectoptionalFulfillment methods offered. Defaults to pickup-only (pickup:true, delivery/shipping:false).
weeklyAvailabilityobject[]optionalThe weekly hours grid: pass every open weekday (each at most once). Omit to create with no hours yet and set them later with updateLocation.
exceptionDatesobject[]optionalHoliday closures / one-off special hours.
orderingClosedUntilnumberoptionalEpoch ms until which ordering is paused.
bookingHorizonDaysintegeroptionalHow far ahead this location's pickup calendar opens, in days: the shop's order-ahead window. Absent = the platform default (30). Up to 730 (two years) for shops that take far-ahead orders (weddings, events).
pickupStartsAtMinuteintegeroptionalThe first pickup time customers may choose, in minutes from midnight LOCAL to the location's timezone (510 = 8:30am), independent of opening hours. Windows that end at or before it are removed; a window straddling it opens at it. Absent =…
taxRegionobjectoptionalSales tax for this location, owner-set. Applies to orders fulfilled here; a product carrying its own rate overrides it.

Returns

Use this to stand up a shop's FIRST location when listLocations returns none (the Cake Ann go-live gap): without an active pickup location that has real hours, online checkout for physical goods…

Declared limits

bookingHorizonDays: minimum 1
bookingHorizonDays: maximum 730
pickupStartsAtMinute: minimum 0
pickupStartsAtMinute: maximum 1439

Ask for it

The Cloud routes these requests to this verb.

create a pickup location
the shop has no location, add one
set up Beverly pickup

Pair it with

The verbs that finish the job.