Skip to main content
POST
/
shipping
/
options
Create a shipping option
curl --request POST \
  --url https://api.salesive.com/api/v1/shipping/options \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard Shipping",
  "description": "3-5 business day delivery",
  "type": "manual",
  "price": 1500,
  "match": "all",
  "triggers": [
    {
      "type": "totalAmount",
      "operator": ">=",
      "value": 10000
    }
  ],
  "enabled": true
}
'
{
  "status": 201,
  "success": true,
  "message": "Create a shipping option",
  "data": {
    "_id": "6650a1f2c3d4e5f601020304",
    "name": "Standard Shipping",
    "description": "3-5 business day delivery",
    "type": "manual",
    "price": 1500,
    "match": "all",
    "couriers": [],
    "triggers": [
      {
        "type": "totalAmount",
        "operator": ">=",
        "value": 10000
      }
    ],
    "enabled": true,
    "shop": "6630b2a1d4e5f60102030405",
    "deleted": false,
    "createdAt": "2026-06-28T09:00:00.000Z",
    "updatedAt": "2026-06-28T09:00:00.000Z"
  }
}
Creates a new shipping option for the store. Trigger rules determine when the option is offered at checkout. For auto options a validated pickup address and coordinates are required so live courier rates can be fetched. 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.

Body

application/json
​
name
string
required

Display name of the shipping option.

​
description
string
required

Description shown to shoppers.

​
type
string

One of auto or manual. Defaults to custom.

​
price
number

Flat shipping price (minimum 0). Defaults to 0.

​
match
string

How triggers combine: all or any. Defaults to all.

​
couriers
string[]

Courier codes to restrict the option to. Defaults to [].

​
triggers
object[]

Eligibility rules. Each has type (totalAmount|country|state|city|zipCode|distance|custom), operator (=|!=|>|<|>=|<=|in|notIn|contains|notContains), value, and optional unit, source, coordinates, metadata. Defaults to [].

​
enabled
boolean

Whether the option is active. Defaults to true.

​
pickupAddress
string

Pickup address string (required for auto options).

​
pickupCoordinates
object

Pickup coordinates { lat, lng } (required for auto options).

Response

Create 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.