List Shipping Options

Retrieve a list of Shipping Options. The shipping options can be filtered by fields such as region_id or is_return.

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of shipping options skipped when retrieving the shipping options.

limit

integer

required

The number of items per page

shipping_options

array[object (Shipping Option) {19}]

required

An array of shipping options details.

string

required

The shipping option's ID

Example:

so_01G1G5V27GYX4QXNARRQCW1N8T

name

string

required

The name given to the Shipping Option - this may be displayed to the Customer.

Example:

PostFake Standard

region_id

string

required

The ID of the region this shipping option can be used in.

Example:

reg_01G1G5V26T9H8Y0M4JNE3YGA4G

region

object | null

optional

The details of the region this shipping option can be used in.

profile_id

string

required

The ID of the Shipping Profile that the shipping option belongs to.

Example:

sp_01G1G5V239ENSZ5MV4JAR737BM

provider_id

string

required

The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.

Example:

manual

amount

integer | null

required

The amount to charge for shipping when the Shipping Option price type is flat_rate.

Example:

200

is_return

boolean

required

Flag to indicate if the Shipping Option can be used for Return shipments.

Default:

false

admin_only

boolean

required

Flag to indicate if the Shipping Option usage is restricted to admin users.

Default:

false

includes_tax

boolean

optional

Whether the shipping option price include tax

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

price_type

enum<string>

required

The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be flat_rate for fixed prices or calculated if the Fulfillment Provider can provide price calulations.

Allowed values:

flat_ratecalculated

Example:

flat_rate

data

object

required

The data needed for the Fulfillment Provider to identify the Shipping Option.

Example:

{}

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

provider

object (Fulfillment Provider)

optional

A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the fulfillment service's installation status.

requirements

array[object (Shipping Option Requirement) {6}]

optional

The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.

profile

object (Shipping Profile)

optional

A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type gift_card groups together the shipping options that can only be used for gift cards.

Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "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"
        }
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Shipping Options

Request

Request samples

Responses