How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Medusa Shipping Options API

A shipping option is a way of shipping an item to or from the customer.Shipping options are associated with the fulfillment provider used to handle their fulfillment.Shipping options can be restricted geographically by service zones, and by custom rules, such as an item's weight or the customer's group.These API routes allow admins to manage shipping options.

Medusa Shipping Options API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipping Options. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 5 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

8 operations 5 paths 26 schemas 1 DELETE3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Medusa Shipping Options API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Shipping Options 8

A shipping option is a way of shipping an item to or from the customer. Shipping options are associated with the fulfillment provider used to handle their fulfillment. Shipping op…

GET
/admin/shipping-options
List Shipping Options
GetShippingOptions 17 params → 200400401404409422500
POST
/admin/shipping-options
Create Shipping Option
PostShippingOptions 1 param body → 200400401404409422500
GET
/admin/shipping-options/{id}
Get a Shipping Option
GetShippingOptionsId 2 params → 200400401404409422500
POST
/admin/shipping-options/{id}
Update a Shipping Option
PostShippingOptionsId 2 params body → 200400401404409422500
DELETE
/admin/shipping-options/{id}
Delete a Shipping Option
DeleteShippingOptionsId 1 param → 200400401404409422500
POST
/admin/shipping-options/{id}/rules/batch
Manage the Rules of a Shipping Option
PostShippingOptionsIdRulesBatch 2 params body → 200400401404409422500
GET
/store/shipping-options
List Shipping Options for Cart
GetShippingOptions 11 params → 200400401404409422500
POST
/store/shipping-options/{id}/calculate
Calculate Shipping Option Price
PostShippingOptionsIdCalculate 5 params body → 200400401404409422500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are AdminShippingOption (18 properties), StoreCalculatedPrice (14 properties), AdminShippingOptionPrice (13 properties), StoreFulfillmentAddress (13 properties). Each schema is shown below with its type and property counts.

AdminShippingOptionPrice
object
The details of the shipping option's price.
13 properties 13 required
AdminShippingProfile
object
The shipping profile's details..
7 properties 7 required
AdminCreateShippingOptionRule
object
The details of the shipping option rule.
3 properties 3 required
AdminCreateCalculatedShippingOption
object
The calculated shipping option's details.
10 properties 5 required
PriceRule
object
The price rule's details.
3 properties 3 required
AdminShippingOptionResponse
object
The shipping option's details.
1 property 1 required
AdminUpdateShippingOptionPriceWithCurrency
object
The properties to update in a shipping option price with a currency.
4 properties
Error
object
3 properties
AdminShippingOptionPriceRule
object
The details of a shipping option price's rule.
9 properties 9 required
AdminShippingOptionType
object
The shipping option's details.
8 properties 8 required
AdminShippingOption
object
The shipping option's details.
18 properties 18 required
AdminFulfillmentProvider
object
The fulfillment provider's details.
2 properties 2 required
AdminUpdateShippingOption
object
The properties to update in the shipping option type.
10 properties
AdminUpdateShippingOptionPriceWithRegion
object
The properties to update in a shipping option price with a region.
4 properties
AdminShippingOptionDeleteResponse
object
The details of the shipping option's deletion.
3 properties 3 required
AdminUpdateShippingOptionRule
object
The properties to update in the shipping option rule.
4 properties 4 required
AdminCreateFlatRateShippingOption
object
The flat rate shipping option's details.
11 properties 6 required
AdminCreateShippingOptionType
object
The shipping option type's details.
3 properties 2 required
AdminShippingOptionRule
object
The shipping option rule's details.
8 properties 8 required
StorePriceRule
object
The price rule's details.
4 properties 4 required
StoreCartShippingOption
object
The shipping option's details.
13 properties 13 required
StorePrice
object
The price's details.
6 properties 5 required
StoreCalculatedPrice
object
The shipping option's calculated price.
14 properties 6 required
StoreShippingOptionListResponse
object
The list of shipping options.
1 property 1 required
StoreFulfillmentAddress
object
The location's address details.
13 properties 13 required
StoreShippingOptionResponse
object
The shipping option's details.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-shipping-options-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Shipping Options API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.