swagger: '2.0'
info:
  version: '2.0'
  title: store-alternative-languages
consumes:
  - application/json
produces:
  - application/json
paths:
  /store-alternative-languages:
    get:
      tags:
        - store-alternative-languages
      description: Get a collection of store alternative languages.
      operationId: getStoreAlternativeLanguages
      parameters:
        - name: storeId
          in: query
          description: The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.
          required: false
          type: integer
          format: int32
        - name: languageId
          in: query
          description: The language Id for the requested language.
          required: false
          type: integer
          format: int32
        - name: altLanguageId
          in: query
          description: The language Id for the alternative language.
          required: false
          type: integer
          format: int32
        - name: sequence
          in: query
          description: 'When the requested language is supported (see the store-languages resource) but information is not available in that language, each alternative language is tried in ascending order of SEQUENCE. A store may override the SEQUENCE specified for its StoreGroup.'
          required: false
          type: number
          format: double
        - 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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of store alternative languages relationship.
          schema:
            $ref: '#/definitions/StoreAlternativeLanguageCollection'
        '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-alternative-languages
      description: Create a store alternative language.
      operationId: createStoreAlternativeLanguage
      parameters:
        - in: body
          name: StoreAlternativeLanguage
          description: The store alternative language resource.
          required: true
          schema:
            $ref: '#/definitions/StoreAlternativeLanguage'
      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-alternative-languages/storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}':
    get:
      tags:
        - store-alternative-languages
      description: Get a store alternative language.
      operationId: getStoreAlternativeLanguageById
      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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: The store alternative language resource.
          schema:
            $ref: '#/definitions/StoreAlternativeLanguage'
        '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-alternative-languages
      description: Delete a store alternative language.
      operationId: deleteStoreAlternativeLanguageById
      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-alternative-languages
      description: Update a store alternative language.
      operationId: updateStoreAlternativeLanguageById
      parameters:
        - in: body
          name: StoreAlternativeLanguage
          description: The store alternative language resource.
          required: true
          schema:
            $ref: '#/definitions/StoreAlternativeLanguage'
      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 for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: The language Id for the requested language.
        required: true
        type: integer
        format: int32
      - name: altLanguageId
        in: path
        description: The language Id for the alternative language.
        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.
  StoreAlternativeLanguage:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.
      languageId:
        type: integer
        format: int32
        description: The language Id for the requested language.
      altLanguageId:
        type: integer
        format: int32
        description: The language Id for the alternative language.
      sequence:
        type: number
        format: double
        description: 'When the requested language is supported (see the store-languages resource) but information is not available in that language, each alternative language is tried in ascending order of SEQUENCE. A store may override the SEQUENCE specified for its StoreGroup.'
    description: The store alternative language resource.
  StoreAlternativeLanguageCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StoreAlternativeLanguage'
    description: A collection of store alternative languages relationship.
