Campaigns Shipping Methods Partial Update

Authorization

oauth2 campaigns:write

AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: campaigns:write

Path Parameters

id*integer

Campaign ID.

shippingMethodId*integer

Shipping method reference ID, unique within the campaign.

Header Parameters

X-29next-API-Version*"2024-04-01"

Default"2024-04-01"

Value in

"2024-04-01"

Request Body

prices?array<>

Per-currency prices to update for the shipping method. Currencies not included are left unchanged.

recalculate_prices?boolean

Whether to recalculate prices for currencies not included in prices, via forex conversion. Source is the campaign's default currency if included in prices, else the first currency listed — include the default currency or submit only one to avoid ambiguity.

Defaultfalse

shipping_method?string

Shipping method code from the store's configured shipping methods. name is re-populated automatically from this when provided.

Lengthlength <= 128

Response Body

`application/json`

curl -X PATCH "https://example.com/campaigns/0/shipping-methods/0/" \  -H "X-29next-API-Version: 2024-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 0,  "name": "string",  "prices": [    {      "currency": "str",      "price": "string"    }  ],  "shipping_method": "string"}