Update a location by ID. Use the id value returned in a Location resource response, such as from GET /locations, as this path parameter. Omit a field to keep its current value. Top-level objects and scalar fields cannot be set to null. For platform-sourced locations, only address.email, address.phone, timezone_identifier, opening_hours, and order_processing can be patched; other fields are managed by the ecommerce platform.
Location ID. Use the id value returned in a Location resource response, such as from GET /locations, as this path parameter.
The location name. This field cannot be patched for platform-sourced locations.
Patch the address and contact information of the location. The address object itself cannot be null; omit a field to keep its current value. For platform-sourced locations, only email and phone can be patched. For Location resources, first_name and last_name are joined into one contact name on write; on read, the full contact name is returned as first_name and last_name is empty. The type field is accepted by the schema but not used for Location resources — omit it on write; on read it is always empty.
The name of the company associated to the address.
The first name of the person associated to the address.
The last name of the person associated to the address.
The phone number of the person associated to the address.
The email address of the person associated to the address.
First line of the street address.
Second line of the street address.
Third line of the street address.
The location's city, town, or village.
The state or region of the location, such as a province, state, or prefecture.
The address country/region in ISO 3166-1 alpha-3 format.
The postal code of the location.
The coordinate of the address. If coordinate is provided, both latitude and longitude are required.
The name of the timezone where the location is located, as defined by the IANA timezone database standard.
Patch the regular opening hours of the location. The opening_hours object itself cannot be null. You may provide only the weekdays to update, but each provided weekday object is replaced atomically and must include open. When open is false, from and to must be null or omitted. When open is true, from and to must both be provided in HH:mm format or both be null for 24-hour operation.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.
Patch the order processing setting for this location. The order_processing object itself cannot be null. Omitted fields keep their current values. Sending only enabled toggles the setting without clearing order_cutoff_time or order_processing_duration_days; when enabling order processing, the final setting must include a valid cutoff time and processing duration.
Whether order processing is enabled for this location.
The daily cutoff time for processing orders in HH:mm format.
The number of business days needed to process an order. Use 0 when fulfillment can be completed within 1 business day.
Patch the pickup setting for this location. The pickup_setting object itself cannot be null. Omitted fields keep their current values. Sending only enabled toggles the setting without clearing existing pickup fields; when enabling pickup, the final setting must include valid minimum and maximum processing durations. This field cannot be patched for platform-sourced locations.
Whether pickup is enabled for this location.
Pickup instructions shown to the customer.
The minimum number of seconds needed before the order is ready for pickup.
The maximum number of seconds needed before the order is ready for pickup.