swagger: '2.0'
info:
  version: '2.0'
  title: available-receipts
consumes:
  - application/json
produces:
  - application/json
paths:
  /available-receipts:
    get:
      tags:
        - available-receipts
      description: Get a collection of available receipts.
      operationId: getAvailableReceipts
      parameters:
        - name: id
          in: query
          description: Unique identifier.
          required: false
          type: integer
          format: int64
        - name: precedence
          in: query
          description: An INTEGER that Represents the order in which inventory should be picked. Picking starts with the lowest number first.
          required: false
          type: integer
          format: int32
        - name: updatedDateTime
          in: query
          description: The last time this available-receipts was updated.
          required: false
          type: string
          format: date-time
        - name: receiptId
          in: query
          description: Indicates which receipt is available under the istribution arrangement.
          required: false
          type: integer
          format: int64
        - name: distributionArrangement
          in: query
          description: Indicates the distribution arrangement under which this receipt is available.
          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
        - 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 available receipts.
          schema:
            $ref: '#/definitions/AvailableReceiptCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - available-receipts
      description: Create an available receipt.
      operationId: createAvailableReceipt
      parameters:
        - in: body
          name: AvailableReceipt
          description: The available receipt.
          required: true
          schema:
            $ref: '#/definitions/AvailableReceipt'
      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'
  '/available-receipts/{id}':
    get:
      tags:
        - available-receipts
      description: Get an available receipt.
      operationId: getAvailableReceiptById
      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 available receipt.
          schema:
            $ref: '#/definitions/AvailableReceipt'
        '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:
        - available-receipts
      description: Delete an available receipt.
      operationId: deleteAvailableReceiptById
      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:
        - available-receipts
      description: Update an available receipt.
      operationId: updateAvailableReceiptById
      parameters:
        - in: body
          name: AvailableReceipt
          description: The available receipt.
          required: true
          schema:
            $ref: '#/definitions/AvailableReceipt'
      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: Unique identifier.
        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.
  AvailableReceipt:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: Unique identifier.
      precedence:
        type: integer
        format: int32
        description: An INTEGER that Represents the order in which inventory should be picked. Picking starts with the lowest number first.
      updatedDateTime:
        type: string
        format: date-time
        description: The last time this available-receipts was updated.
      receiptId:
        type: integer
        format: int64
        description: Indicates which receipt is available under the istribution arrangement.
      distributionArrangement:
        type: integer
        format: int64
        description: Indicates the distribution arrangement under which this receipt is available.
    description: The available receipt.
  AvailableReceiptCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/AvailableReceipt'
    description: A collection of available receipts.
