Create shipping zone pickup location

post

https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-zones-v2/{zone_id}/pickup-locations

Creates a pickup location for the v2 shipping zone with the given zone id, from the given name, plus an optional sync-to-business-address flag, address, and pickup instructions. Unlike an account-wide pickup location there is no enabled flag: every pickup location a zone holds is offered at checkout, and removing one stops offering it. Returns the created pickup location.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_name

string

required

The site's unique name (its ID), returned when the site is created.

zone_id

string

required

The shipping zone's ID.

Body Params

A pickup location offered by a v2 shipping zone. Unlike the account-wide
Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalCreatePickupLocationRequestDto there is no enabled flag: every pickup location a zone
holds is offered at checkout, and a merchant removes one to stop offering it.

name

string

required

length ≥ 1

Display name of the pickup location.

sync_to_business_address

boolean

Whether the location follows the store's business address. When true, Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalCreateShippingZonePickupLocationRequestDto.Address is ignored.

address

object | null

Address of the pickup location. Required unless Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalCreateShippingZonePickupLocationRequestDto.SyncToBusinessAddress is true.

instructions

string | null

Pickup instructions shown to the customer at this location.

scheduling

object | null

Lets customers schedule their pickup. Null or omitted disables the scheduling and deletes its configuration.

Responses

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

429Too many requests. The rate limit was exceeded.