Medusa Fulfillment Sets API

openapi: 3.2.0
info:
  version: 2.19.0
  title: Medusa Admin Fulfillment Sets API
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/develop/LICENSE
  description: 'A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up".


    All fulfillment-related configurations in a store are related to a fulfillment set.


    These API routes allow admin users to manage fulfillment sets.

    '
servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
tags:
- name: Fulfillment Sets
  description: 'A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up".


    All fulfillment-related configurations in a store are related to a fulfillment set.


    These API routes allow admin users to manage fulfillment sets.

    '
  externalDocs:
    description: Learn more about fulfillment sets.
    url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/concepts
  x-associatedSchema:
    $ref: '#/components/schemas/AdminFulfillmentSet'
paths:
  /admin/fulfillment-sets/{id}:
    delete:
      operationId: DeleteFulfillmentSetsId
      summary: Delete Fulfillment Set
      description: Delete a fulfillment set.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The fulfillment set's ID.
        required: true
        schema:
          type: string
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.fulfillmentSet.delete(\"fset_123\")\n.then(({ deleted }) => {\n  console.log(deleted)\n})"
      - lang: Shell
        label: cURL
        source: 'curl -X DELETE ''{backend_url}/admin/fulfillment-sets/{id}'' \

          -H ''Authorization: Bearer {jwt_token}'''
      tags:
      - Fulfillment Sets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminFulfillmentSetDeleteResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: deleteFulfillmentSetsWorkflow
      x-events: []
  /admin/fulfillment-sets/{id}/service-zones:
    post:
      operationId: PostFulfillmentSetsIdServiceZones
      summary: Add a Service Zone to a Fulfillment Set
      x-sidebar-summary: Add Service Zone
      description: Add a service zone to a fulfillment set.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The fulfillment set's ID.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: 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.
        required: false
        schema:
          type: string
          title: fields
          description: 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.
          externalDocs:
            url: '#select-fields-and-relations'
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminCreateFulfillmentSetServiceZone'
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.fulfillmentSet.createServiceZone(\"fset_123\", {\n  name: \"Europe Service Zone\",\n  geo_zones: [{\n    type: \"country\",\n    country_code: \"us\"\n  }]\n})\n.then(({ fulfillment_set }) => {\n  console.log(fulfillment_set)\n})"
      - lang: Shell
        label: cURL
        source: "curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \\\n-H 'Authorization: Bearer {jwt_token}' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Layla\"\n}'"
      tags:
      - Fulfillment Sets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminFulfillmentSetResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createServiceZonesWorkflow
      x-events: []
  /admin/fulfillment-sets/{id}/service-zones/{zone_id}:
    get:
      operationId: GetFulfillmentSetsIdServiceZonesZone_id
      summary: Get a Service Zone in a Fulfillment Set
      x-sidebar-summary: Get a Service Zone
      description: Retrieve a service zone that belongs to a fulfillment set. be paginated.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The fulfillment set's ID.
        required: true
        schema:
          type: string
      - name: zone_id
        in: path
        description: The service zone's ID.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: 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.
        required: false
        schema:
          type: string
          title: fields
          description: 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.
          externalDocs:
            url: '#select-fields-and-relations'
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.fulfillmentSet.retrieveServiceZone(\n  \"fset_123\",\n  \"serzo_123\"\n)\n.then(({ service_zone }) => {\n  console.log(service_zone)\n})"
      - lang: Shell
        label: cURL
        source: 'curl ''{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}'' \

          -H ''Authorization: Bearer {jwt_token}'''
      tags:
      - Fulfillment Sets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminServiceZoneResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    post:
      operationId: PostFulfillmentSetsIdServiceZonesZone_id
      summary: Update the Service Zone of a Fulfillment Set
      x-sidebar-summary: Update Service Zone
      description: Update the details of a service zone in a fulfillment set.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The fulfillment set's ID.
        required: true
        schema:
          type: string
      - name: zone_id
        in: path
        description: The service zone's ID.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: 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.
        required: false
        schema:
          type: string
          title: fields
          description: 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.
          externalDocs:
            url: '#select-fields-and-relations'
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminUpdateFulfillmentSetServiceZone'
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.fulfillmentSet.updateServiceZone(\n  \"fset_123\", \n  \"serzo_123\",\n  {\n    name: \"Europe Service Zone\",\n  }\n)\n.then(({ fulfillment_set }) => {\n  console.log(fulfillment_set)\n})"
      - lang: Shell
        label: cURL
        source: "curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \\\n-H 'Authorization: Bearer {jwt_token}' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Elvis\"\n}'"
      tags:
      - Fulfillment Sets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminFulfillmentSetResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateServiceZonesWorkflow
      x-events: []
    delete:
      operationId: DeleteFulfillmentSetsIdServiceZonesZone_id
      summary: Remove a Service Zone from Fulfillment Set
      x-sidebar-summary: Remove Service Zone
      description: Remove a service zone that belongs to a fulfillment set.
      x-authenticated: true
      parameters:
      - name: id
        in: path
        description: The fulfillment set's ID.
        required: true
        schema:
          type: string
      - name: zone_id
        in: path
        description: The service zone's ID.
        required: true
        schema:
          type: string
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.fulfillmentSet.deleteServiceZone(\n  \"fset_123\", \n  \"serzo_123\",\n)\n.then(({ deleted, parent: fulfillmentSet }) => {\n  console.log(deleted, fulfillmentSet)\n})"
      - lang: Shell
        label: cURL
        source: 'curl -X DELETE ''{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}'' \ -H ''Authorization: Bearer {jwt_token}'''
      tags:
      - Fulfillment Sets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminServiceZoneDeleteResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: deleteServiceZonesWorkflow
      x-events: []
components:
  schemas:
    AdminShippingOptionPrice:
      type: object
      description: The details of the shipping option's price.
      x-schemaName: AdminShippingOptionPrice
      required:
      - price_rules
      - rules_count
      - id
      - title
      - currency_code
      - amount
      - raw_amount
      - min_quantity
      - max_quantity
      - price_set_id
      - created_at
      - updated_at
      - deleted_at
      properties:
        price_rules:
          type: array
          description: The price's rules.
          items:
            $ref: '#/components/schemas/AdminShippingOptionPriceRule'
        rules_count:
          type: number
          title: rules_count
          description: The number of rules the price has.
        id:
          type: string
          title: id
          description: The price's ID.
        title:
          type: string
          title: title
          description: The price's title.
        currency_code:
          type: string
          title: currency_code
          description: The price's currency code.
          example: usd
        amount:
          type: number
          title: amount
          description: The price's amount.
        raw_amount:
          type: object
          description: The price's raw amount.
        min_quantity:
          type: number
          title: min_quantity
          description: The minimum quantity required in the cart for this price to apply.
        max_quantity:
          type: number
          title: max_quantity
          description: The maximum quantity that the cart's items must not surpass for this price to apply.
        price_set_id:
          type: string
          title: price_set_id
          description: The ID of the price set this price belongs to.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price was deleted.
    AdminShippingProfile:
      type: object
      description: The shipping profile's details..
      x-schemaName: AdminShippingProfile
      properties:
        id:
          type: string
          title: id
          description: The shipping profile's ID.
        name:
          type: string
          title: name
          description: The shipping profile's name.
        type:
          type: string
          title: type
          description: The shipping profile's type.
        metadata:
          type: object
          description: The shipping profile's metadata, holds custom key-value pairs.
          externalDocs:
            url: https://docs.medusajs.com/api/admin#manage-metadata
            description: Learn how to manage metadata
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the shipping profile was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the shipping profile was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the shipping profile was deleted.
      required:
      - id
      - name
      - type
      - metadata
      - created_at
      - updated_at
      - deleted_at
    AdminFulfillmentSetDeleteResponse:
      type: object
      description: The deletion details.
      x-schemaName: AdminFulfillmentSetDeleteResponse
      required:
      - id
      - object
      - deleted
      properties:
        id:
          type: string
          title: id
          description: The fulfillment set's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: fulfillment_set
        deleted:
          type: boolean
          title: deleted
          description: Whether the fulfillment set was deleted.
    AdminFulfillmentSetResponse:
      type: object
      description: The fulfillment set's details.
      x-schemaName: AdminFulfillmentSetResponse
      required:
      - fulfillment_set
      properties:
        fulfillment_set:
          $ref: '#/components/schemas/AdminFulfillmentSet'
    AdminCreateFulfillmentSetServiceZone:
      type: object
      description: Details of the service zone to create for the fulfillment set.
      required:
      - name
      - geo_zones
      properties:
        name:
          type: string
          title: name
          description: The service zone's name.
        geo_zones:
          type: array
          description: The service zone's geo zones.
          items:
            oneOf:
            - type: object
              description: A country geo zone.
              required:
              - metadata
              - country_code
              - type
              properties:
                metadata:
                  type: object
                  description: The geo zone's metadata.
                  externalDocs:
                    url: https://docs.medusajs.com/api/admin#manage-metadata
                    description: Learn how to manage metadata
                country_code:
                  type: string
                  title: country_code
                  description: The geo zone's country code.
                type:
                  type: string
                  title: type
                  description: The geo zone's type.
                  default: country
            - type: object
              description: A province geo zone.
              required:
              - metadata
              - country_code
              - type
              - province_code
              properties:
                metadata:
                  type: object
                  description: The geo zone's metadata.
                  externalDocs:
                    url: https://docs.medusajs.com/api/admin#manage-metadata
                    description: Learn how to manage metadata
                country_code:
                  type: string
                  title: country_code
                  description: The geo zone's country code.
                type:
                  type: string
                  title: type
                  description: The geo zone's type.
                  default: province
                province_code:
                  type: string
                  title: province_code
                  description: The geo zone's ISO 3166-2 province code. Must be lower-case.
                  example: us-ca
                  externalDocs:
                    url: https://en.wikipedia.org/wiki/ISO_3166-2
                    description: Learn more about ISO 3166-2
            - type: object
              description: A city geo zone
              required:
              - metadata
              - country_code
              - type
              - province_code
              - city
              properties:
                metadata:
                  type: object
                  description: The geo zone's metadata.
                  externalDocs:
                    url: https://docs.medusajs.com/api/admin#manage-metadata
                    description: Learn how to manage metadata
                country_code:
                  type: string
                  title: country_code
                  description: The geo zone's country code.
                type:
                  type: string
                  title: type
                  description: The geo zone's type.
                  default: city
                province_code:
                  type: string
                  title: province_code
                  description: The geo zone's ISO 3166-2 province code. Must be lower-case.
                  example: us-ca
                  externalDocs:
                    url: https://en.wikipedia.org/wiki/ISO_3166-2
                    description: Learn more about ISO 3166-2
                city:
                  type: string
                  title: city
                  description: The geo zone's city.
            - type: object
              description: A ZIP geo zone.
              required:
              - metadata
              - country_code
              - type
              - province_code
              - city
              - postal_expression
              properties:
                metadata:
                  type: object
                  description: The geo zone's metadata.
                  externalDocs:
                    url: https://docs.medusajs.com/api/admin#manage-metadata
                    description: Learn how to manage metadata
                country_code:
                  type: string
                  title: country_code
                  description: The geo zone's country code.
                type:
                  type: string
                  title: type
                  description: The geo zone's type.
                  default: zip
                province_code:
                  type: string
                  title: province_code
                  description: The geo zone's ISO 3166-2 province code. Must be lower-case.
                  example: us-ca
                  externalDocs:
                    url: https://en.wikipedia.org/wiki/ISO_3166-2
                    description: Learn more about ISO 3166-2
                city:
                  type: string
                  title: city
                  description: The geo zone's city.
                postal_expression:
                  type: object
                  description: The geo zone's postal expression or ZIP code.
      x-schemaName: AdminCreateFulfillmentSetServiceZone
    Error:
      title: Response Error
      type: object
      properties:
        code:
          type: string
          description: A slug code to indicate the type of the error.
          enum:
          - invalid_state_error
          - invalid_request_error
          - api_error
          - unknown_error
        message:
          type: string
          description: Description of the error that occurred.
          example: first_name must be a string
        type:
          type: string
          description: A slug indicating the type of the error.
          enum:
          - QueryRunnerAlreadyReleasedError
          - TransactionAlreadyStartedError
          - TransactionNotStartedError
          - conflict
          - unauthorized
          - payment_authorization_error
          - duplicate_error
          - not_allowed
          - invalid_data
          - not_found
          - database_error
          - unexpected_state
          - invalid_argument
          - unknown_error
    AdminShippingOptionPriceRule:
      type: object
      description: The details of a shipping option price's rule.
      x-schemaName: AdminShippingOptionPriceRule
      required:
      - id
      - value
      - operator
      - attribute
      - price_id
      - priority
      - created_at
      - updated_at
      - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The price rule's ID.
        value:
          oneOf:
          - type: string
            title: value
            description: The price rule's value.
          - type: number
            title: value
            description: The price rule's value.
          description: The price rule's value.
        operator:
          type: string
          description: The price rule's operator.
          enum:
          - gt
          - lt
          - eq
          - ne
          - in
          - lte
          - gte
          - nin
        attribute:
          type: string
          title: attribute
          description: The price rule's attribute.
        price_id:
          type: string
          title: price_id
          description: The ID of the price this rule applies to.
        priority:
          type: number
          title: priority
          description: The price rule's priority.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price rule was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price rule was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price rule was deleted.
    AdminShippingOptionType:
      type: object
      description: The shipping option's details.
      x-schemaName: AdminShippingOptionType
      required:
      - id
      - label
      - description
      - code
      - shipping_option_id
      - created_at
      - updated_at
      - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The shipping option's ID.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the shipping option was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the shipping option was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the shipping option was deleted.
        label:
          type: string
          title: label
          description: The type's label.
        description:
          type: string
          title: description
          description: The type's description.
        code:
          type: string
          title: code
          description: The type's code.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The type's shipping option id.
    AdminShippingOption:
      type: object
      description: The shipping option's details.
      x-schemaName: AdminShippingOption
      required:
      - id
      - name
      - price_type
      - service_zone_id
      - service_zone
      - provider_id
      - provider
      - shipping_option_type_id
      - type
      - shipping_profile_id
      - shipping_profile
      - rules
      - prices
      - data
      - metadata
      - created_at
      - updated_at
      - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The shipping option's ID.
        name:
          type: string
          title: name
          description: The shipping option's name.
        price_type:
          type: string
          description: 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.
          enum:
          - calculated
          - flat
        service_zone_id:
          type: string
          title: service_zone_id
          description: The ID of the service zone this option belongs to.
        service_zone:
          type: object
        provider_id:
          type: string
          title: provider_id
          description: The ID of the provider handling fulfillments created from this shipping option.
        provider:
          $ref: '#/components/schemas/AdminFulfillmentProvider'
        shipping_option_type_id:
          type: string
          title: shipping_option_type_id
          description: The ID of the associated shipping option type.
        type:
          $ref: '#/components/schemas/AdminShippingOptionType'
        shipping_profile_id:
          type: string
          title: shipping_profile_id
          description: The ID of the associated shipping profile.
        shipping_profile:
          $ref: '#/components/schemas/AdminShippingProfile'
        rules:
          type: array
          description: The shipping option's rules.
          items:
            $ref: '#/components/schemas/AdminShippingOptionRule'
        prices:
          type: array
          description: 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.
          items:
            $ref: '#/components/schemas/AdminShippingOptionPrice'
        data:
          type: object
          description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.
          externalDocs:
            url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
        metadata:
          type: object
          description: The shipping option's metadata, can hold custom key-value pairs.
          externalDocs:
            url: https://docs.medusajs.com/api/admin#manage-metadata
            description: Learn how to manage metadata
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the shipping option was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the shipping option was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the shipping option was deleted.
    AdminUpdateFulfillmentSetServiceZone:
      type: object
      description: The service zone's details.
      properties:
        name:
          type: string
          title: name
          description: The service zone's name.
        geo_zones:
          type: array
          description: The service zone's associated geo zones.
          items:
            oneOf:
            - type: object
              description: A country geo zone.
              required:
              - type
              - metadata
              - country_code
              properties:
                type:
                  type: string
                  title: type
                  description: The geo zone's type.
                  default: country
                metadata:
                  type: object
                  description: The geo zone's metadata.
                  externalDocs:
                    url: https://docs.medusajs.com/api/admin#manage-metadata
                    description: Learn how to manage metadata
                country_code:
                  type: string
                  title: country_code
                  description: The geo zone's country code.
                id:
                  type: string
                  title: id
                  description: The ID of an existing geo zone.
            - type: object
      

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/medusa/refs/heads/main/openapi/medusa-fulfillment-sets-api-openapi.yml