Beta
Not authenticated — log in first
VendorShipping Methods

Update Shipping Method

Update Shipping Method — vendor REST API endpoint.

PATCH/vendor/me/shipping-methods/:idVendor bearer token required

Update 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 sending `countryRates`, it replaces the full rate list.

When to use this

  • Updating shipping rates or deactivating a method.

Path parameters

NameTypeRequiredDescription
idstring (UUID)YesShipping method ID.

Request body

NameTypeRequiredDescription
namestringNoUpdated name.
isActivebooleanNoEnable or disable.
pricingTypestringNo`FLAT_RATE` or `WEIGHT_BASED`.
currencystringNoISO currency code (max 3).
descriptionstringNoOptional description.
countryRates[].countryCodestringNoISO country code. Sending `countryRates` replaces the entire rate list.
countryRates[].flatRatenumberNoUpdated flat rate for this country.

Request example

curl -X PATCH 'https://api.next.gcommerce.glass/api/v1/vendor/me/shipping-methods/550e8400-e29b-41d4-a716-446655440060' \
  -H 'Content-Type: application/json'

Response examples

200Success
{
  "id": "550e8400-e29b-41d4-a716-446655440060",
  "name": "Standard Shipping",
  "isActive": true,
  "pricingType": "FLAT_RATE",
  "weightLimitMin": null,
  "weightLimitMax": null,
  "currency": "USD",
  "description": "5-7 business days",
  "countryRates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440061",
      "methodId": "550e8400-e29b-41d4-a716-446655440060",
      "countryCode": "US",
      "flatRate": "9.99",
      "baseRate": null,
      "weightTiers": []
    }
  ],
  "createdAt": "2025-03-01T10:00:00.000Z",
  "updatedAt": "2025-03-01T10:00:00.000Z"
}

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.

429

Too Many Requests

Global rate limit exceeded (10,000 requests per 10 minutes per IP).

500

Internal Server Error

Unexpected server error.

403

Forbidden

No vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).

There is no top-level `flatRateAmount`. Rates belong under `countryRates[].flatRate`.
If you include `countryRates`, send a non-empty array — an empty array is rejected.

Try it

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