Skip to main content
POST
/
admin
/
fulfillment-sets
/
{id}
/
service-zones
/
{zone_id}
JS SDK
import Medusa from "@medusajs/js-sdk"

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

sdk.admin.fulfillmentSet.updateServiceZone(
  "fset_123", 
  "serzo_123",
  {
    name: "Europe Service Zone",
  }
)
.then(({ fulfillment_set }) => {
  console.log(fulfillment_set)
})
{
  "fulfillment_set": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "location": {
      "id": "<string>",
      "name": "<string>",
      "address_id": "<string>",
      "address": {
        "id": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "company": "<string>",
        "country_code": "us",
        "city": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "province": "us-ca"
      },
      "sales_channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "is_disabled": true,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "fulfillment_providers": [
        {
          "id": "<string>",
          "is_enabled": true
        }
      ],
      "fulfillment_sets": [
        {}
      ]
    },
    "service_zones": [
      {
        "id": "<string>",
        "name": "<string>",
        "fulfillment_set_id": "<string>",
        "fulfillment_set": {},
        "geo_zones": [
          {
            "id": "<string>",
            "type": "country",
            "country_code": "<string>",
            "province_code": "us-ca",
            "city": "<string>",
            "postal_expression": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "shipping_options": [
          {
            "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"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "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

​
id
string
required

The fulfillment set's ID.

​
zone_id
string
required

The service zone'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 service zone's details.

​
name
string

The service zone's name.

​
geo_zones
object[]

The service zone's associated geo zones.

A country geo zone.

Response

OK

The fulfillment set's details.

​
fulfillment_set
object
required

The service zone's fulfillment set.