Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Shipping Options
  • Getting Started
    • Introduction
    • Authentication
    • HTTP Compression
    • Publishable API Key
    • Expanding Fields
    • Selecting Fields
    • Query Parameter Types
    • Pagination
  • Auth
    • Check if Email Exists
      GET
    • Customer Login (JWT)
      POST
    • Customer Login (JWT)
      POST
    • Customer Log out
      DELETE
    • Get Current Customer
      GET
    • Customer Login
      POST
  • Carts
    • Create Payment Sessions
      POST
    • Update a Payment Session
      POST
    • Delete a Payment Session
      DELETE
    • Create a Cart
      POST
    • Get a Cart
      GET
    • Update a Cart
      POST
    • Remove Discount
      DELETE
    • Add a Line Item
      POST
    • Update a Line Item
      POST
    • Delete a Line Item
      DELETE
    • Select a Payment Session
      POST
    • Refresh a Payment Session
      POST
    • Add Shipping Method
      POST
    • Calculate Cart Taxes
      POST
    • Complete a Cart
      POST
  • Customers
    • Get Saved Payment Methods
    • Request Password Reset
    • Update a Shipping Address
    • Delete an Address
    • Create a Customer
    • Get a Customer
    • Update Customer
    • Add a Shipping Address
    • Reset Password
    • List Orders
  • Gift Cards
    • Get Gift Card by Code
  • Orders
    • Claim Order
    • Verify Order Claim
    • Look Up an Order
    • Get by Cart ID
    • Get an Order
  • Order Edits
    • Retrieve an Order Edit
    • Decline an Order Edit
    • Complete an Order Edit
  • Payment Collections
    • Refresh a Payment Session
    • Authorize Payment Session
    • Get a PaymentCollection
    • Create a Payment Session
    • Manage Payment Sessions
    • Authorize Payment Sessions
  • Products
    • Search Products
    • Get a Product
    • List Products
  • Product Variants
    • Get Product Variants
    • Get a Product Variant
  • Product Categories
    • Get a Product Category
    • List Product Categories
  • Product Collections
    • List Collections
    • Get a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Regions
    • Get a Region
    • List Regions
  • Returns
    • Create Return
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Shipping Options
    • List for Cart
      GET
    • Get Shipping Options
      GET
  • Swaps
    • Create a Swap
    • Get by Cart ID
  1. Shipping Options

Get Shipping Options

GET
/store/shipping-options
Retrieve a list of Shipping Options.

Request

Query Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.medusa-commerce.com/store/shipping-options'

Responses

🟢200OK
application/json
Body

Example
{
    "shipping_options": [
        {
            "id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
            "name": "PostFake Standard",
            "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
            "region": {},
            "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
            "provider_id": "manual",
            "amount": 200,
            "is_return": false,
            "admin_only": false,
            "includes_tax": false,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "price_type": "flat_rate",
            "data": {},
            "metadata": {
                "car": "white"
            },
            "provider": {
                "id": "manual",
                "is_installed": true
            },
            "requirements": [
                {
                    "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD",
                    "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
                    "shipping_option": {},
                    "amount": 100,
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "type": "min_subtotal"
                }
            ],
            "profile": {
                "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                "name": "Default Shipping Profile",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "type": "default",
                "products": [
                    {}
                ],
                "shipping_options": [
                    {}
                ],
                "metadata": {
                    "car": "white"
                }
            },
            "price_incl_tax": 0,
            "tax_amount": 0,
            "tax_rates": [
                {
                    "rate": 0,
                    "name": "string",
                    "code": "string"
                }
            ]
        }
    ]
}
🟠400Client Error or Multiple Errors
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2024-01-06 03:57:20
Previous
List for Cart
Next
Create a Swap
Built with