Skip to content

AppUpdateShippingMethod

PUT
/apps/shipping/methods/{id}
curl --request PUT \
--url https://your-store.myciqra.com/apps/shipping/methods/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "audience": "All", "currency": "example", "enabled": true, "freeOverSubtotal": 1, "leadTimeMaxDays": 1, "leadTimeMinDays": 1, "name": "example", "rateCarrierId": "example", "rateCarrierService": "example", "rateSource": "Table", "rateType": "Flat", "rates": [ { "amount": 1, "maxValue": 1, "minValue": 1 } ], "sortOrder": 1 }'

Required scope: write_shipping — an installation token without it receives 403.

id
required
string format: uuid
Media typeapplication/json
object
audience
Allowed values: All RetailOnly B2bOnly
currency
required
string
enabled
required
boolean
freeOverSubtotal
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
leadTimeMaxDays
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
leadTimeMinDays
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
name
required
string
rateCarrierId
null | string
rateCarrierService
null | string
rateSource
Allowed values: Table Carrier
rateType
required
Allowed values: Flat Weight Price
rates
required
Array<object>
object
amount
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
maxValue
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
minValue
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
sortOrder
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

OK

Media typeapplication/json
object
audience
Allowed values: All RetailOnly B2bOnly
currency
required
string
enabled
required
boolean
freeOverSubtotal
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
gaps
required
Array<object>
object
from
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
to
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
id
required
string format: uuid
leadTimeMaxDays
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
leadTimeMinDays
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
name
required
string
rateCarrierId
required
null | string
rateCarrierService
required
null | string
rateSource
required
Allowed values: Table Carrier
rateType
required
Allowed values: Flat Weight Price
rates
required
Array<object>
object
amount
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
maxValue
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
minValue
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
sortOrder
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
zoneId
required
string format: uuid
Example
{
"audience": "All",
"rateSource": "Table",
"rateType": "Flat"
}

Not Found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
scope
required
null | string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"scope": "example"
}
}

Conflict

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
scope
required
null | string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"scope": "example"
}
}

Unprocessable Entity

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
scope
required
null | string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"request_id": "example",
"scope": "example"
}
}