Skip to main content
PUT
/
shipping
/
options
/
{id}
Update a shipping option
curl --request PUT \
  --url https://api.salesive.com/api/v1/shipping/options/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "price": 2000,
  "enabled": false
}
'
{
  "status": 200,
  "success": true,
  "message": "Update a shipping option",
  "data": {
    "_id": "6650a1f2c3d4e5f601020304",
    "name": "Standard Shipping",
    "description": "3-5 business day delivery",
    "type": "custom",
    "price": 2000,
    "match": "all",
    "couriers": [],
    "triggers": [
      {
        "type": "totalAmount",
        "operator": ">=",
        "value": 10000
      }
    ],
    "enabled": false,
    "shop": "6630b2a1d4e5f60102030405",
    "deleted": false,
    "createdAt": "2026-05-20T10:00:00.000Z",
    "updatedAt": "2026-06-28T09:30:00.000Z"
  }
}
Updates an existing shipping option. Only the provided fields are changed. The option must belong to the store bound to the app token. Requires the WRITE_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

id
string
required

ObjectId of the shipping option.

Body

application/json
name
string

Display name of the shipping option.

description
string

Description shown to shoppers.

type
string

One of auto or manual.

price
number

Flat shipping price (minimum 0).

match
string

How triggers combine: all or any.

couriers
string[]

Courier codes to restrict the option to.

triggers
object[]

Eligibility rules (same shape as on create).

enabled
boolean

Whether the option is active.

pickupAddress
string

Pickup address string.

pickupCoordinates
object

Pickup coordinates { lat, lng }.

Response

Update a shipping option.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A configured shipping option. For options of type auto, the store-level shipping configuration is merged into the object.