Update shipping zone (V2)

patch

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

Updates the v2 shipping zone with the given id. Accepts changes to name, locations, subzones, pickup locations, and the Easyship automated shipping flag; supplying subzones or pickup locations replaces the whole collection and regenerates their ids, so edit an existing entry through its own endpoint to keep its id stable.

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.

string

required

Body Params

Partial update of a v2 shipping zone. Only the fields present in the body are changed; omitted fields keep
their current value. A supplied Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalUpdateShippingZoneV2RequestDto.Subzones or Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalUpdateShippingZoneV2RequestDto.PickupLocations replaces the whole
collection and regenerates the ids it holds — edit one entry through its own endpoint to keep ids stable.

name

string | null

locations

array of objects | null

locations

subzones

array of objects | null

subzones

A subzone of a v2 shipping zone: the postal code patterns it scopes, and the shipping methods offered inside
them. Patterns may not overlap across the subzones of a zone.

postal_codes_patterns

array of strings, unique

required

length ≤ 50000

Postal codes, and partial postal code patterns ending with '*', scoped to this subzone. Empty means the
subzone applies to every postal code its zone covers.

postal_codes_patterns*

shipping_methods

array of objects

required

Shipping methods offered by this subzone. A subzone with no method offers no way to ship, which is how a
merchant excludes the postal codes it scopes.

shipping_methods*

has_automated_shipping

boolean | null

pickup_locations

array of objects | null

pickup_locations

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

429Too many requests. The rate limit was exceeded.