AppUpdateShippingMethod
PUT
/apps/shipping/methods/{id}
const url = 'https://your-store.myciqra.com/apps/shipping/methods/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
audience
currency
required
string
enabled
required
boolean
freeOverSubtotal
required
null | number | string format: double
leadTimeMaxDays
required
null | integer | string format: int32
leadTimeMinDays
required
null | integer | string format: int32
name
required
string
rateCarrierId
null | string
rateCarrierService
null | string
rateSource
rateType
required
rates
required
Array<object>
object
amount
required
number | string format: double
maxValue
required
null | number | string format: double
minValue
required
number | string format: double
sortOrder
required
integer | string format: int32
Responses
Section titled “Responses”OK
Media typeapplication/json
object
audience
currency
required
string
enabled
required
boolean
freeOverSubtotal
required
null | number | string format: double
gaps
required
Array<object>
object
from
required
number | string format: double
to
required
null | number | string format: double
id
required
string format: uuid
leadTimeMaxDays
required
null | integer | string format: int32
leadTimeMinDays
required
null | integer | string format: int32
name
required
string
rateCarrierId
required
null | string
rateCarrierService
required
null | string
rateSource
required
rateType
required
rates
required
Array<object>
object
amount
required
number | string format: double
maxValue
required
null | number | string format: double
minValue
required
number | string format: double
sortOrder
required
integer | string format: int32
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" }}