swagger: '2.0'
info:
  version: '2.0'
  title: currency-conversions
consumes:
  - application/json
produces:
  - application/json
paths:
  /currency-conversions:
    get:
      tags:
        - currency-conversions
      description: Get a collection of currency conversions.
      operationId: getCurrencyConversions
      parameters:
        - name: id
          in: query
          description: Generated unique key.
          required: false
          type: integer
          format: int32
        - name: storeEntityId
          in: query
          description: The StoreEntity.
          required: false
          type: integer
          format: int32
        - name: fromCurrency
          in: query
          description: 'An amount in the FROMCURR currency is normally part of a rule. Or is part of other information used to determine a price, discount, shipping charge. Or is part of similar amount associated with a product offered for sale.'
          required: false
          type: string
        - name: toCurrency
          in: query
          description: 'TOCURR is normally the currency in which the customer intends to pay. Amounts in this currency are normally part of an OrderItem, such as a unit price, shipping charge, or tax amount.'
          required: false
          type: string
        - name: conversionFactor
          in: query
          description: The conversion factor. Implicit conversion rules may be derived from explicit rules by combining conversion factors. But no more than one unidirectional rule can be used to derive any particular implicit rule.
          required: false
          type: number
        - name: multiplyOrDivide
          in: query
          description: 'To convert from FROMCURR to TOCURR M = Multiply by FACTOR D = Divide by FACTOR. For bidirectional rules, conversion from TOCURR to FROMCURR is allowed using the inverse operation.'
          required: false
          type: string
        - name: bidirectional
          in: query
          description: Indicates whether the rule is bidirectional or unidirectional Y = bidirectional. N = unidirectional.
          required: false
          type: string
        - name: updatable
          in: query
          description: A flag intended to be used by a user interface that manages currency conversion rules. Valid values N = conversion rate is irrevocable - should never be changed Y = conversion rate can be changed.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of currency conversions.
          schema:
            $ref: '#/definitions/CurrencyConversionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - currency-conversions
      description: Create a currency conversion.
      operationId: createCurrencyConversion
      parameters:
        - in: body
          name: CurrencyConversion
          description: The rule can be used to convert a price to an amount(customer will be charged in a supported shopping currency).
          required: true
          schema:
            $ref: '#/definitions/CurrencyConversion'
      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'
  '/currency-conversions/{id}':
    get:
      tags:
        - currency-conversions
      description: Get a currency conversion.
      operationId: getCurrencyConversionById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: The rule can be used to convert a price to an amount(customer will be charged in a supported shopping currency).
          schema:
            $ref: '#/definitions/CurrencyConversion'
        '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:
        - currency-conversions
      description: Delete a currency conversion.
      operationId: deleteCurrencyConversionById
      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:
        - currency-conversions
      description: Update a currency conversion.
      operationId: updateCurrencyConversionById
      parameters:
        - in: body
          name: CurrencyConversion
          description: The rule can be used to convert a price to an amount(customer will be charged in a supported shopping currency).
          required: true
          schema:
            $ref: '#/definitions/CurrencyConversion'
      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: id
        in: path
        description: Generated unique key.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  CurrencyConversion:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Generated unique key.
      storeEntityId:
        type: integer
        format: int32
        description: The StoreEntity.
      fromCurrency:
        type: string
        description: 'An amount in the FROMCURR currency is normally part of a rule. Or is part of other information used to determine a price, discount, shipping charge. Or is part of similar amount associated with a product offered for sale.'
      toCurrency:
        type: string
        description: 'TOCURR is normally the currency in which the customer intends to pay. Amounts in this currency are normally part of an OrderItem, such as a unit price, shipping charge, or tax amount.'
      conversionFactor:
        type: number
        description: The conversion factor. Implicit conversion rules may be derived from explicit rules by combining conversion factors. But no more than one unidirectional rule can be used to derive any particular implicit rule.
      multiplyOrDivide:
        type: string
        description: 'To convert from FROMCURR to TOCURR M = Multiply by FACTOR D = Divide by FACTOR. For bidirectional rules, conversion from TOCURR to FROMCURR is allowed using the inverse operation.'
      bidirectional:
        type: string
        description: Indicates whether the rule is bidirectional or unidirectional Y = bidirectional. N = unidirectional.
      updatable:
        type: string
        description: A flag intended to be used by a user interface that manages currency conversion rules. Valid values N = conversion rate is irrevocable - should never be changed Y = conversion rate can be changed.
    description: The rule can be used to convert a price to an amount(customer will be charged in a supported shopping currency).
  CurrencyConversionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/CurrencyConversion'
    description: A collection of currency conversions.
