medusa-store/docs/api/admin/paths/regions_{id}.yaml

delete:
  operationId: DeleteRegionsRegion
  summary: Delete a Region
  description: Deletes a Region.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Region.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/regions_{id}/deleteundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/regions_{id}/deleteundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Region
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The ID of the deleted Region.
              object:
                type: string
                description: The type of the object that was deleted.
                default: region
              deleted:
                type: boolean
                description: Whether or not the items were deleted.
                default: true
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
get:
  operationId: GetRegionsRegion
  summary: Get a Region
  description: Retrieves a Region.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Region.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/regions_{id}/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/regions_{id}/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Region
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              region:
                $ref: ../components/schemas/region.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
post:
  operationId: PostRegionsRegion
  summary: Update a Region
  description: Updates a Region
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Region.
      schema:
        type: string
  requestBody:
    content:
      application/json:
        schema:
          type: object
          properties:
            name:
              description: The name of the Region
              type: string
            currency_code:
              description: The 3 character ISO currency code to use for the Region.
              type: string
              externalDocs:
                url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
                description: See a list of codes.
            automatic_taxes:
              description: >-
                If true Medusa will automatically calculate taxes for carts in
                this region. If false you have to manually call POST
                /carts/:id/taxes.
              type: boolean
            gift_cards_taxable:
              description: >-
                Whether gift cards in this region should be applied sales tax
                when purchasing a gift card
              type: boolean
            tax_provider_id:
              description: >-
                The ID of the tax provider to use; if null the system tax
                provider is used
              type: string
            tax_code:
              description: An optional tax code the Region.
              type: string
            tax_rate:
              description: The tax rate to use on Orders in the Region.
              type: number
            includes_tax:
              description: '[EXPERIMENTAL] Tax included in prices of region'
              type: boolean
            payment_providers:
              description: >-
                A list of Payment Provider IDs that should be enabled for the
                Region
              type: array
              items:
                type: string
            fulfillment_providers:
              description: >-
                A list of Fulfillment Provider IDs that should be enabled for
                the Region
              type: array
              items:
                type: string
            countries:
              description: >-
                A list of countries' 2 ISO Characters that should be included in
                the Region.
              type: array
              items:
                type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/regions_{id}/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/regions_{id}/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Region
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              region:
                $ref: ../components/schemas/region.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml