swagger: '2.0'
info:
  version: '2.0'
  title: store-categories
consumes:
  - application/json
produces:
  - application/json
paths:
  /store-categories:
    get:
      tags:
        - store-categories
      description: Get a collection of store categories.
      operationId: getStoreCategories
      parameters:
        - name: id
          in: query
          description: Generated unique key represents the store category ID.
          required: false
          type: integer
          format: int32
        - name: name
          in: query
          description: A unique name for the store category.
          required: false
          type: string
        - name: remark
          in: query
          description: The default currency for a store entity that will be used by a customer who has not specified a preferred currency.
          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 store categories.
          schema:
            $ref: '#/definitions/StoreCategoryCollection'
        '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-categories
      description: ''
      operationId: createStoreCategory
      parameters:
        - in: body
          name: StoreCategory
          description: The store category.
          required: true
          schema:
            $ref: '#/definitions/StoreCategory'
      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-categories/{id}':
    get:
      tags:
        - store-categories
      description: Get a store entity.
      operationId: getStoreCategoryById
      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 store category.
          schema:
            $ref: '#/definitions/StoreCategory'
        '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-categories
      description: ''
      operationId: deleteStoreCategoryById
      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-categories
      description: ''
      operationId: updateStoreCategoryById
      parameters:
        - in: body
          name: StoreCategory
          description: The store category.
          required: true
          schema:
            $ref: '#/definitions/StoreCategory'
      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 represents the store category ID.
        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.
  StoreCategory:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Generated unique key represents the store category ID.
      name:
        type: string
        description: A unique name for the store category.
      remark:
        type: string
        description: The default currency for a store entity that will be used by a customer who has not specified a preferred currency.
    description: The store category.
  StoreCategoryCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StoreCategory'
    description: A collection of store categories.
