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

delete:
  operationId: DeleteSalesChannelsSalesChannel
  summary: Delete a Sales Channel
  description: Deletes the sales channel.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Sales channel.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/sales-channels_{id}/deleteundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/sales-channels_{id}/deleteundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Sales Channel
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              id:
                type: string
                description: The ID of the deleted sales channel
              object:
                type: string
                description: The type of the object that was deleted.
                default: sales-channel
              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: GetSalesChannelsSalesChannel
  summary: Get a Sales Channel
  description: Retrieves the sales channel.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Sales channel.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/sales-channels_{id}/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/sales-channels_{id}/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Sales Channel
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              sales_channel:
                $ref: ../components/schemas/sales_channel.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: PostSalesChannelsSalesChannel
  summary: Update a Sales Channel
  description: Updates a Sales Channel.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Sales Channel.
      schema:
        type: string
  requestBody:
    content:
      application/json:
        schema:
          properties:
            name:
              type: string
              description: Name of the sales channel.
            description:
              type: string
              description: Sales Channel description.
            is_disabled:
              type: boolean
              description: Indication of if the sales channel is active.
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/sales-channels_{id}/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/sales-channels_{id}/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Sales Channel
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              sales_channel:
                $ref: ../components/schemas/sales_channel.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