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

delete:
  operationId: DeleteShippingOptionsOption
  summary: Delete a Shipping Option
  description: Deletes a Shipping Option.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Shipping Option.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/shipping-options_{id}/deleteundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/shipping-options_{id}/deleteundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Shipping Option
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              id:
                type: string
                description: The ID of the deleted Shipping Option.
              object:
                type: string
                description: The type of the object that was deleted.
                default: shipping-option
              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: GetShippingOptionsOption
  summary: Get a Shipping Option
  description: Retrieves a Shipping Option.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Shipping Option.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/shipping-options_{id}/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/shipping-options_{id}/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Shipping Option
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              shipping_option:
                $ref: ../components/schemas/shipping_option.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: PostShippingOptionsOption
  summary: Update Shipping Option
  description: Updates a Shipping Option
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Shipping Option.
      schema:
        type: string
  requestBody:
    content:
      application/json:
        schema:
          required:
            - requirements
          properties:
            name:
              description: The name of the Shipping Option
              type: string
            amount:
              description: The amount to charge for the Shipping Option.
              type: integer
            admin_only:
              description: If true, the option can be used for draft orders
              type: boolean
            metadata:
              description: An optional set of key-value pairs with additional information.
              type: object
            requirements:
              description: >-
                The requirements that must be satisfied for the Shipping Option
                to be available.
              type: array
              items:
                required:
                  - type
                  - amount
                properties:
                  id:
                    description: The ID of the requirement
                    type: string
                  type:
                    description: The type of the requirement
                    type: string
                    enum:
                      - max_subtotal
                      - min_subtotal
                  amount:
                    description: The amount to compare with.
                    type: integer
            includes_tax:
              description: '[EXPERIMENTAL] Tax included in prices of shipping option'
              type: boolean
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/shipping-options_{id}/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/shipping-options_{id}/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Shipping Option
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              shipping_option:
                $ref: ../components/schemas/shipping_option.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