Create shipping method (V2)

post

https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-zones-v2/{zone_id}/subzones/{subzone_id}/shipping-methods

Creates a shipping method for the subzone with the given subzone id, within the v2 shipping zone with the given zone id, from the given name, calculation type, and rates, plus an optional delivery time range and shipping group. Returns the created method.

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.

subzone_id

string

required

The shipping subzone's ID.

Body Params

A shipping method owned by a subzone of a v2 shipping zone. Unlike
Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalCreateShippingMethodRequestDto it can be scoped to a shipping group, so a zone can
quote different methods for different products.

name

string

required

length ≥ 1

Display name for the method at checkout.

type

string

enum

required

Calculation type of the shipping method. Dictates validation rules for the array of rates.

Allowed:

rates

array of objects

required

Array of rates. Min one required except for type FREE (none). Max one for type FLAT_RATE.

rates*

min_delivery_time_in_days

int32 | null

0 to 2147483647

Customer facing minimum delivery time in days. Optional.

max_delivery_time_in_days

int32 | null

1 to 2147483647

Customer facing maximum delivery time in days. Optional. Cannot be 0 or lower or equal to min. Can be set
when min is null.

shipping_group_id

string | null

Shipping group this method is offered for. Null or blank, the default, offers it for every product
belonging to no group. Anything else must be an existing shipping group id.

Responses

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

429Too many requests. The rate limit was exceeded.