Skip to main content
POST
/
admin
/
shipping-options
/
{id}
/
rules
/
batch
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.updateRules("so_123", {
  create: [{ attribute: "enabled_in_store", operator: "eq", value: "true" }],
})
.then(({ shipping_option }) => {
  console.log(shipping_option)
})
{
  "created": [
    {
      "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"
    }
  ],
  "updated": [
    {
      "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"
    }
  ],
  "deleted": {
    "ids": [
      "<string>"
    ],
    "object": "shipping_option_rule",
    "deleted": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
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 rules to create, update, or delete.

​
create
object[]

The shipping option rules to create.

​
update
object[]

The shipping option rules to update.

​
delete
string[]

The shipping option rules to delete.

A rule's ID.

Response

OK

The batch operation's result.

​
created
object[]
required

The created shipping option rules.

​
updated
object[]
required

The updated shipping option rules.

​
deleted
object
required

The details of the deleted shipping option rules.