Skip to main content
PATCH
Change a checkout shipping option

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-11-17

Path Parameters

shippingOptionId
string<uuid>
required

ID of the checkout shipping option.

Body

application/json
name
string
Minimum string length: 1
amount
integer

Integer amount in the currency's minor units (Stripe convention): 1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD

Required range: x >= 0
currencyCode
string
rules
object[]
sortOrder
integer
speedTier
enum<string>
Available options:
standard,
express
minDeliveryDays
integer | null
maxDeliveryDays
integer | null
type
enum<string>
Available options:
flat,
carrierCalculated,
pickup
carrierServices
string[]
Maximum array length: 5
Required string length: 1 - 128
handlingAmount
integer

Integer amount in the currency's minor units (Stripe convention): 1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD

Required range: x >= 0
shippingProfileId
string<uuid> | null
pickupInstructions
string | null
Maximum string length: 1000
pickupLocation
object

Response

Change a checkout shipping option

id
string
required
name
string
required
Minimum string length: 1
amount
integer
required

Integer amount in the currency's minor units (Stripe convention): 1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD

Required range: x >= 0
currencyCode
string
required
rules
object[]
required
sortOrder
integer
required
speedTier
enum<string>
required
Available options:
standard,
express
minDeliveryDays
integer | null
required
maxDeliveryDays
integer | null
required
type
enum<string>
required
Available options:
flat,
carrierCalculated,
pickup
carrierServices
string[]
required
Maximum array length: 50
Required string length: 1 - 128
handlingAmount
integer
required

Integer amount in the currency's minor units (Stripe convention): 1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD

Required range: x >= 0
shippingProfileId
string<uuid> | null
required
pickupAddressId
string<uuid> | null
required
pickupInstructions
string | null
required
Maximum string length: 1000
object
enum<string>
required
Available options:
shipping_option