Update shipping method (V2)

Updates the shipping method with the given id, owned by the subzone with the given subzone id within the v2 shipping zone with the given zone id. Accepts changes to name, calculation type, rates, delivery time range, and shipping group. Supplying rates replaces the whole array, and changing the type away from FREE requires rates that match it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required

The shipping zone's ID.

string
required

The shipping subzone's ID.

string
required
Body Params

Partial update of a shipping method owned by a subzone. Only the fields present in the body are changed.
Rates are replaced as a whole when supplied, and a change of Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalUpdateShippingMethodV2RequestDto.Type to anything but FREE has to
carry the rates that match it — the stored ones belong to the old type and would be rejected.

string | null
string | null
enum
Allowed:
rates
array of objects | null
rates
int32 | null

Customer facing minimum delivery time in days. Send null to clear the current estimate; omit to keep it.

int32 | null

Customer facing maximum delivery time in days. Send null to clear the current estimate; omit to keep it.
Cannot be 0 or lower or equal to min.

string | null

Shipping group this method is offered for. Send null, or a blank string, to offer it for every product
belonging to no group; omit to keep the current group.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json