POST/vendor/me/shipping-methodsVendor bearer token required

Create Shipping Method

Create a new shipping method for your vendor.

What this means in plain English

Adds a shipping method. Requires OWNER, ADMIN, or EDITOR role.

When to use this

Setting up flat-rate shipping for your catalog.

Request body

Name	Type	Required	Description
name	string	Yes	Method display name.
flatRateAmount	string	Yes	Flat rate price.
currency	string	No	ISO currency code.
description	string	No	Optional description.

Headers

Name	Type	Required	Description
X-Vendor-Id	string (UUID)	Yes	UUID of the vendor context. Required for vendor-scoped endpoints when your account has multiple vendor memberships. Use the vendor.id from the login response.

Request example

curl -X POST 'http://localhost:8080/api/v1/vendor/me/shipping-methods' \
  -H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Standard Shipping",
  "flatRateAmount": "9.99",
  "currency": "USD",
  "description": "5-7 business days"
}'

Response examples

201Created

{
  "id": "550e8400-e29b-41d4-a716-446655440060",
  "name": "Standard Shipping",
  "pricingType": "FLAT_RATE",
  "flatRateAmount": "9.99",
  "currency": "USD",
  "isActive": true
}

Status codes

200

Request succeeded.

401

Unauthorized

Missing or invalid bearer token.

403

Forbidden

Insufficient permissions for this action.

400

Bad Request

Validation failed or invalid parameters.

404

Not Found

Resource not found.

500

Internal Server Error

Unexpected server error.

403

Forbidden

Invalid X-Vendor-Id, no vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).

Try it

Uses your saved session from login. Edit values and send a live request, or copy the cURL command.

Bearer tokenX-Vendor-IdHeader: X-Vendor-Id *name *flatRateAmount *currencydescription