swagger: '2.0'
info:
  version: '2.0'
  title: item-fulfillment-centers
consumes:
  - application/json
produces:
  - application/json
paths:
  /item-fulfillment-centers:
    get:
      tags:
        - item-fulfillment-centers
      description: Get a collection of item fulfillment centers.
      operationId: getItemFulfillmentCenters
      parameters:
        - name: storeId
          in: query
          description: The reference ID of the store this fulfillment center associated with.
          required: false
          type: integer
          format: int32
        - name: ffmCenterId
          in: query
          description: The fulfillment center.
          required: false
          type: integer
          format: int32
        - name: itemSpcId
          in: query
          description: The item specification.
          required: false
          type: integer
          format: int64
        - name: qtyBackOrdered
          in: query
          description: The quantity of this item backordered for this store and fulfillment center.
          required: false
          type: integer
          format: int32
        - name: qtyAllocBackOrder
          in: query
          description: Amount of in stock inventory allocated to a backorder.
          required: false
          type: integer
          format: int32
        - name: updatedDateTime
          in: query
          description: The updated date and time of this fulfillment center.
          required: false
          type: string
          format: date-time
        - name: qtyReserved
          in: query
          description: 'Reserved amount, may be used for auctions or other purposes.'
          required: false
          type: integer
          format: int32
        - name: restockTime
          in: query
          description: Next planned restock time.
          required: false
          type: string
          format: date-time
        - 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 item fulfillment centers.
          schema:
            $ref: '#/definitions/ItemFulfillmentCenterCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - item-fulfillment-centers
      description: Create a item fulfillment center.
      operationId: createItemFulfillmentCenter
      parameters:
        - in: body
          name: ItemFulfillmentCenter
          description: The item fulfillment center.
          required: true
          schema:
            $ref: '#/definitions/ItemFulfillmentCenter'
      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'
  '/item-fulfillment-centers/storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}':
    get:
      tags:
        - item-fulfillment-centers
      description: Get a item fulfillment center.
      operationId: getItemFulfillmentCenterById
      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 item fulfillment center.
          schema:
            $ref: '#/definitions/ItemFulfillmentCenter'
        '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:
        - item-fulfillment-centers
      description: Delete a item fulfillment center.
      operationId: deleteItemFulfillmentCenterById
      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:
        - item-fulfillment-centers
      description: Update a item fulfillment center.
      operationId: updateItemFulfillmentCenterById
      parameters:
        - in: body
          name: ItemFulfillmentCenter
          description: The item fulfillment center.
          required: true
          schema:
            $ref: '#/definitions/ItemFulfillmentCenter'
      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 reference ID of the store this fulfillment center associated with.
        required: true
        type: integer
        format: int32
      - name: ffmCenterId
        in: path
        description: The fulfillment center.
        required: true
        type: integer
        format: int32
      - name: itemSpcId
        in: path
        description: The item specification.
        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.
  ItemFulfillmentCenter:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The reference ID of the store this fulfillment center associated with.
      ffmCenterId:
        type: integer
        format: int32
        description: The fulfillment center.
      itemSpcId:
        type: integer
        format: int64
        description: The item specification.
      qtyBackOrdered:
        type: integer
        format: int32
        description: The quantity of this item backordered for this store and fulfillment center.
      qtyAllocBackOrder:
        type: integer
        format: int32
        description: Amount of in stock inventory allocated to a backorder.
      updatedDateTime:
        type: string
        format: date-time
        description: The updated date and time of this fulfillment center.
      qtyReserved:
        type: integer
        format: int32
        description: 'Reserved amount, may be used for auctions or other purposes.'
      restockTime:
        type: string
        format: date-time
        description: Next planned restock time.
    description: The item fulfillment center.
  ItemFulfillmentCenterCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/ItemFulfillmentCenter'
    description: A collection of item fulfillment centers.
