swagger: '2.0'
info:
  version: 2.0.0
  title: store-transports
host: localhost
basePath: /rest/admin/v2/
tags:
  - name: store-transports
paths:
  /store-transports/swagger.json:
    get:
      tags:
        - store-transports
      operationId: getSwaggerJson_1
      produces:
        - application/json
      parameters:
        - name: path
          in: path
          required: true
          type: string
      responses:
        default:
          description: successful operation
  /store-transports:
    get:
      tags:
        - store-transports
      description: Get a collection of Store transports.
      operationId: getStoreTransports
      parameters:
        - name: storeId
          in: query
          description: The Store ID.
          required: false
          type: integer
          format: int32
        - name: transportId
          in: query
          description: The transport.
          required: false
          type: integer
          format: int32
        - name: active
          in: query
          description: If it is active.
          required: false
          type: integer
          format: int32
        - name: offset
          in: query
          description: The index of the first item to be returned.
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of items to be returned.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: The fields to be returned.
          required: false
          type: string
        - name: expand
          in: query
          description: The related resources to be embedded.
          required: false
          type: string
      responses:
        '200':
          description: A collection of Store transports.
          schema:
            $ref: '#/definitions/StoreTransportCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - store-transports
      description: Create an Store transport.
      operationId: createStoreTransport
      parameters:
        - in: body
          name: StoreTransport
          description: An store transport.
          required: true
          schema:
            $ref: '#/definitions/StoreTransport'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/store-transports/storeId:{storeId},transportId:{transportId}':
    get:
      tags:
        - store-transports
      description: Get an Store transport.
      operationId: getStoreTransportById
      parameters:
        - name: fields
          in: query
          description: The fields to be returned.
          required: false
          type: string
        - name: expand
          in: query
          description: The related resources to be embedded.
          required: false
          type: string
      responses:
        '200':
          description: An store transport.
          schema:
            $ref: '#/definitions/StoreTransport'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - store-transports
      description: Delete an Store transport.
      operationId: deleteStoreTransportById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - store-transports
      description: Update an Store transport.
      operationId: updateStoreTransportById
      parameters:
        - in: body
          name: StoreTransport
          description: An store transport.
          required: true
          schema:
            $ref: '#/definitions/StoreTransport'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: storeId
        in: path
        description: The Store ID.
        required: true
        type: integer
        format: int32
      - name: transportId
        in: path
        description: The transport.
        required: true
        type: integer
        format: int32
  '/store-transports/storeId:{storeId},transportId:{transportId}/transports':
    get:
      tags:
        - store-transports
      description: Finds the transport in a store-transport relationship.
      operationId: getTransportsOfStoreTransport
      parameters:
        - name: fields
          in: query
          description: The fields to be returned.
          required: false
          type: string
        - name: expand
          in: query
          description: The related resources to be embedded.
          required: false
          type: string
      responses:
        '200':
          description: An store transport.
          schema:
            $ref: '#/definitions/Transport'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: storeId
        in: path
        description: The Store ID.
        required: true
        type: integer
        format: int32
      - name: transportId
        in: path
        description: The transport.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
  Error:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      messageKey:
        type: string
      messageArguments:
        type: array
        items:
          type: object
      correlationId:
        type: string
      locale:
        type: string
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
      errors:
        type: array
        items:
          $ref: '#/definitions/Error'
  StoreTransport:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The Store ID.
      transportId:
        type: integer
        format: int32
        description: The transport.
      active:
        type: integer
        format: int32
        description: If it is active.
      links:
        type: object
        description: Links to related resources.
        properties:
          transports:
            type: object
            description: The transport.
            properties:
              href:
                type: string
                description: The URL of the link.
    description: An store transport.
  StoreTransportCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StoreTransport'
    description: A collection of Store transports.
  Transport:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The transport ID.
      code:
        type: string
        description: The code of the transport.
      name:
        type: string
        description: The name of the transport.
      description:
        type: string
        description: The description.
      timeout:
        type: integer
        format: int32
        description: The timeout.
      implemented:
        type: string
        description: If it is implemented.
      addressable:
        type: string
        description: If it is addressable.
    description: An store transport.
