Update a Shipping Option

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.shippingOption.update("so_123", {
  name: "Standard Shipping",
})
.then(({ shipping_option }) => {
  console.log(shipping_option)
})

{
  "shipping_option": {
    "id": "<string>",
    "name": "<string>",
    "price_type": "calculated",
    "service_zone_id": "<string>",
    "service_zone": {},
    "provider_id": "<string>",
    "provider": {
      "id": "<string>",
      "is_enabled": true
    },
    "shipping_option_type_id": "<string>",
    "type": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "description": "<string>",
      "code": "<string>",
      "shipping_option_id": "<string>"
    },
    "shipping_profile_id": "<string>",
    "shipping_profile": {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "rules": [
      {
        "id": "<string>",
        "attribute": "is_return",
        "operator": "gt",
        "value": "true",
        "shipping_option_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "prices": [
      {
        "price_rules": [
          {
            "id": "<string>",
            "value": "<string>",
            "operator": "gt",
            "attribute": "<string>",
            "price_id": "<string>",
            "priority": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "rules_count": 123,
        "id": "<string>",
        "title": "<string>",
        "currency_code": "usd",
        "amount": 123,
        "raw_amount": {},
        "min_quantity": 123,
        "max_quantity": 123,
        "price_set_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "data": {},
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

POST

admin

shipping-options

{id}

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.shippingOption.update("so_123", {
  name: "Standard Shipping",
})
.then(({ shipping_option }) => {
  console.log(shipping_option)
})

{
  "shipping_option": {
    "id": "<string>",
    "name": "<string>",
    "price_type": "calculated",
    "service_zone_id": "<string>",
    "service_zone": {},
    "provider_id": "<string>",
    "provider": {
      "id": "<string>",
      "is_enabled": true
    },
    "shipping_option_type_id": "<string>",
    "type": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "description": "<string>",
      "code": "<string>",
      "shipping_option_id": "<string>"
    },
    "shipping_profile_id": "<string>",
    "shipping_profile": {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "rules": [
      {
        "id": "<string>",
        "attribute": "is_return",
        "operator": "gt",
        "value": "true",
        "shipping_option_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "prices": [
      {
        "price_rules": [
          {
            "id": "<string>",
            "value": "<string>",
            "operator": "gt",
            "attribute": "<string>",
            "price_id": "<string>",
            "priority": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "rules_count": 123,
        "id": "<string>",
        "title": "<string>",
        "currency_code": "usd",
        "amount": 123,
        "raw_amount": {},
        "min_quantity": 123,
        "max_quantity": 123,
        "price_set_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "data": {},
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The shipping option's ID.

Query Parameters

fields

string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The properties to update in the shipping option type.

name

string

The shipping option's name.

data

object

The shipping option's data.

price_type

enum<string>

The shipping option's price type.

Available options:

flat,

calculated

provider_id

string

The shipping option's provider id.

shipping_profile_id

string

The shipping option's shipping profile id.

type

object

The shipping option type's details.

Show child attributes

type.label

string

required

The type's label.

type.code

string

required

The type's code.

type.description

string

The type's description.

type_id

string

The shipping option's type id.

prices

object[]

The shipping option's prices.

The price's prices.

Option 1
Option 2

Show child attributes

prices.id

string

The price's ID.

prices.currency_code

string

The price's currency code.

prices.amount

number

The price's amount.

prices.rules

object[]

The price's rules.

Show child attributes

prices.rules.attribute

string

required

The rule's attribute.

prices.rules.operator

enum<string>

required

The rule's operator.

Available options:

gt,

lt,

eq,

lte,

gte

prices.rules.value

number

required

The rule's value.

rules

object[]

The shipping option's rules.

The rule's rules.

Option 1
Option 2

Show child attributes

rules.operator

enum<string>

required

The rule's operator.

Available options:

gt,

lt,

eq,

ne,

in,

lte,

gte,

nin

rules.attribute

string

required

The rule's attribute.

rules.value

required

The rule's value.

metadata

object

The shipping option's metadata.

Response

The shipping option's details.

shipping_option

object

required

The shipping option's details.

Show child attributes

shipping_option.id

string

required

The shipping option's ID.

shipping_option.name

string

required

The shipping option's name.

shipping_option.price_type

enum<string>

required

The shipping option's price type. If it's flat, the price is fixed and is set in the prices property. If it's calculated, the price is calculated on checkout by the associated fulfillment provider.

Available options:

calculated,

flat

shipping_option.service_zone_id

string

required

The ID of the service zone this option belongs to.

shipping_option.service_zone

object

required

shipping_option.provider_id

string

required

The ID of the provider handling fulfillments created from this shipping option.

shipping_option.provider

object

required

The fulfillment provider's details.

Show child attributes

shipping_option.provider.id

string

required

The provider's ID.

shipping_option.provider.is_enabled

boolean

required

The provider's is enabled.

shipping_option.shipping_option_type_id

string

required

The ID of the associated shipping option type.

shipping_option.type

object

required

The shipping option's details.

Show child attributes

shipping_option.type.id

string

required

The shipping option's ID.

shipping_option.type.created_at

string<date-time>

required

The date the shipping option was created.

shipping_option.type.updated_at

string<date-time>

required

The date the shipping option was updated.

shipping_option.type.deleted_at

string<date-time>

required

The date the shipping option was deleted.

shipping_option.type.label

string

required

The type's label.

shipping_option.type.description

string

required

The type's description.

shipping_option.type.code

string

required

The type's code.

shipping_option.type.shipping_option_id

string

required

The type's shipping option id.

shipping_option.shipping_profile_id

string

required

The ID of the associated shipping profile.

shipping_option.shipping_profile

object

required

The shipping profile's details..

Show child attributes

shipping_option.shipping_profile.id

string

required

The shipping profile's ID.

shipping_option.shipping_profile.name

string

required

The shipping profile's name.

shipping_option.shipping_profile.type

string

required

The shipping profile's type.

shipping_option.shipping_profile.metadata

object

required

The shipping profile's metadata, holds custom key-value pairs.

shipping_option.shipping_profile.created_at

string<date-time>

required

The date the shipping profile was created.

shipping_option.shipping_profile.updated_at

string<date-time>

required

The date the shipping profile was updated.

shipping_option.shipping_profile.deleted_at

string<date-time>

required

The date the shipping profile was deleted.

shipping_option.rules

object[]

required

The shipping option's rules.

Show child attributes

shipping_option.rules.id

string

required

The shipping option rule's ID.

shipping_option.rules.attribute

string

required

The shipping option rule's attribute.

Example:

"is_return"

shipping_option.rules.operator

enum<string>

required

The rule's operator.

Available options:

gt,

lt,

eq,

ne,

in,

lte,

gte,

nin

shipping_option.rules.value

required

The shipping option rule's value.

Example:

"true"

shipping_option.rules.shipping_option_id

string

required

The ID of the shipping option this rule is for.

shipping_option.rules.created_at

string<date-time>

required

The date the shipping option rule was created.

shipping_option.rules.updated_at

string<date-time>

required

The date the shipping option rule was updated.

shipping_option.rules.deleted_at

string<date-time>

required

The date the shipping option rule was deleted.

shipping_option.prices

object[]

required

The shipping option's prices. If the price_type is calculated, this array will be empty since the price is calculated by the fulfillment provider during checkout.

Show child attributes

shipping_option.prices.price_rules

object[]

required

The price's rules.

Show child attributes

shipping_option.prices.price_rules.id

string

required

The price rule's ID.

shipping_option.prices.price_rules.value

required

The price rule's value.

shipping_option.prices.price_rules.operator

enum<string>

required

The price rule's operator.

Available options:

gt,

lt,

eq,

ne,

in,

lte,

gte,

nin

shipping_option.prices.price_rules.attribute

string

required

The price rule's attribute.

shipping_option.prices.price_rules.price_id

string

required

The ID of the price this rule applies to.

shipping_option.prices.price_rules.priority

number

required

The price rule's priority.

shipping_option.prices.price_rules.created_at

string<date-time>

required

The date the price rule was created.

shipping_option.prices.price_rules.updated_at

string<date-time>

required

The date the price rule was updated.

shipping_option.prices.price_rules.deleted_at

string<date-time>

required

The date the price rule was deleted.

shipping_option.prices.rules_count

number

required

The number of rules the price has.

shipping_option.prices.id

string

required

The price's ID.

shipping_option.prices.title

string

required

The price's title.

shipping_option.prices.currency_code

string

required

The price's currency code.

Example:

"usd"

shipping_option.prices.amount

number

required

The price's amount.

shipping_option.prices.raw_amount

object

required

The price's raw amount.

shipping_option.prices.min_quantity

number

required

The minimum quantity required in the cart for this price to apply.

shipping_option.prices.max_quantity

number

required

The maximum quantity that the cart's items must not surpass for this price to apply.

shipping_option.prices.price_set_id

string

required

The ID of the price set this price belongs to.

shipping_option.prices.created_at

string<date-time>

required

The date the price was created.

shipping_option.prices.updated_at

string<date-time>

required

The date the price was updated.

shipping_option.prices.deleted_at

string<date-time>

required

The date the price was deleted.

shipping_option.data

object

required

The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.

shipping_option.metadata

object

required

The shipping option's metadata, can hold custom key-value pairs.

shipping_option.created_at

string<date-time>

required

The date the shipping option was created.

shipping_option.updated_at

string<date-time>

required

The date the shipping option was updated.

shipping_option.deleted_at

string<date-time>

required

The date the shipping option was deleted.

Get a Shipping Option

Delete a Shipping Option

⌘I

Overview

Scanner API

Admin API

Authorizations

Path Parameters

Query Parameters

Body

Response