G
Not authenticated — log in first
VendorShipping Methods

List Shipping Methods

List Shipping Methods — vendor REST API endpoint.

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

List Shipping Methods

List all shipping methods configured for your vendor.

What this means in plain English

Returns the shipping methods available for your vendor store.

When to use this

  • Reviewing configured shipping options.
  • Selecting a method when creating shipments.

Headers

NameTypeRequiredDescription
X-Vendor-Idstring (UUID)YesUUID 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 GET 'http://localhost:8080/api/v1/vendor/me/shipping-methods' \
  -H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010'

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.