VendorShipping Methods
Update Shipping Method
Update Shipping Method — vendor REST API endpoint.
PATCH
/vendor/me/shipping-methods/:idVendor bearer token requiredUpdate Shipping Method
Update an existing shipping method.
What this means in plain English
Partially update a shipping method by ID. Requires OWNER, ADMIN, or EDITOR role.
When to use this
- Updating shipping rates or deactivating a method.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Yes | Shipping method ID. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | No | Updated name. |
| flatRateAmount | string | No | Updated rate. |
| isActive | boolean | No | Enable or disable. |
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 PATCH 'http://localhost:8080/api/v1/vendor/me/shipping-methods/550e8400-e29b-41d4-a716-446655440060' \
-H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010' \
-H 'Content-Type: application/json' \
-d '{
"name": "Express Shipping",
"flatRateAmount": "19.99",
"isActive": "true"
}'Response examples
200Success
{
"id": "550e8400-e29b-41d4-a716-446655440060",
"name": "Standard Shipping",
"pricingType": "FLAT_RATE",
"flatRateAmount": "9.99",
"currency": "USD",
"isActive": true
}Status codes
200
OK
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.