swagger: '2.0'
info:
  version: '2.0'
  title: store-member-groups
consumes:
  - application/json
produces:
  - application/json
paths:
  /store-member-groups:
    get:
      tags:
        - store-member-groups
      description: Get a collection of stores and recognized member groups.
      operationId: getStoreMemberGroups
      parameters:
        - name: storeId
          in: query
          description: The store ID.
          required: false
          type: integer
          format: int32
        - name: memberGroupId
          in: query
          description: The member group ID.
          required: false
          type: integer
          format: int64
        - 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 stores and recognized member groups.
          schema:
            $ref: '#/definitions/StoreMemberGroupCollection'
        '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-member-groups
      description: Create a store and recognized member groups.
      operationId: createStoreMemberGroup
      parameters:
        - in: body
          name: StoreMemberGroup
          description: A store recognizes a member group as a customer group.
          required: true
          schema:
            $ref: '#/definitions/StoreMemberGroup'
      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-member-groups/storeId:{storeId},memberGroupId:{memberGroupId}':
    get:
      tags:
        - store-member-groups
      description: Get a store and recognized member groups.
      operationId: getStoreMemberGroupById
      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: A store recognizes a member group as a customer group.
          schema:
            $ref: '#/definitions/StoreMemberGroup'
        '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-member-groups
      description: Delete a store and recognized member groups.
      operationId: deleteStoreMemberGroupById
      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-member-groups
      description: Update a store and recognized member groups.
      operationId: updateStoreMemberGroupById
      parameters:
        - in: body
          name: StoreMemberGroup
          description: A store recognizes a member group as a customer group.
          required: true
          schema:
            $ref: '#/definitions/StoreMemberGroup'
      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: memberGroupId
        in: path
        description: The member group ID.
        required: true
        type: integer
        format: int64
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.
  StoreMemberGroup:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The store ID.
      memberGroupId:
        type: integer
        format: int64
        description: The member group ID.
    description: A store recognizes a member group as a customer group.
  StoreMemberGroupCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StoreMemberGroup'
    description: A collection of stores and recognized member groups.
