swagger: '2.0'
info:
  version: '2.0'
  title: fulfillment-center-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /fulfillment-center-descriptions:
    get:
      tags:
        - fulfillment-center-descriptions
      description: Get a collection of fulfillment center descriptions.
      operationId: getFulfillmentCenterDescriptions
      parameters:
        - name: fulfillmentCenterId
          in: query
          description: The fulfillment center ID.
          required: false
          type: integer
          format: int32
        - name: displayName
          in: query
          description: 'A string that, along with its language Id, uniquely identifies this fulfillment center.'
          required: false
          type: string
        - name: description
          in: query
          description: The fulfillment center description in the language.
          required: false
          type: string
        - name: storeAddressId
          in: query
          description: The physical location of the FulfillmentCenter.
          required: false
          type: integer
          format: int32
        - name: languageId
          in: query
          description: 'The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.'
          required: false
          type: integer
          format: int32
        - 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 fulfillment center descriptions.
          schema:
            $ref: '#/definitions/FulfillmentCenterDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - fulfillment-center-descriptions
      description: Create a fulfillment description.
      operationId: createFulfillmentCenterDescription
      parameters:
        - in: body
          name: FulfillmentCenterDescription
          description: Fulfillment center description.
          required: true
          schema:
            $ref: '#/definitions/FulfillmentCenterDescription'
      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'
  '/fulfillment-center-descriptions/fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}':
    get:
      tags:
        - fulfillment-center-descriptions
      description: Get a fulfillment description.
      operationId: getFulfillmentCenterDescriptionById
      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: Fulfillment center description.
          schema:
            $ref: '#/definitions/FulfillmentCenterDescription'
        '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:
        - fulfillment-center-descriptions
      description: Delete a fulfillment description.
      operationId: deleteFulfillmentCenterDescriptionById
      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:
        - fulfillment-center-descriptions
      description: Update a fulfillment description.
      operationId: updateFulfillmentCenterDescriptionById
      parameters:
        - in: body
          name: FulfillmentCenterDescription
          description: Fulfillment center description.
          required: true
          schema:
            $ref: '#/definitions/FulfillmentCenterDescription'
      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: fulfillmentCenterId
        in: path
        description: The fulfillment center ID.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: 'The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.'
        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.
  FulfillmentCenterDescription:
    type: object
    properties:
      fulfillmentCenterId:
        type: integer
        format: int32
        description: The fulfillment center ID.
      displayName:
        type: string
        description: 'A string that, along with its language Id, uniquely identifies this fulfillment center.'
      description:
        type: string
        description: The fulfillment center description in the language.
      storeAddressId:
        type: integer
        format: int32
        description: The physical location of the FulfillmentCenter.
      languageId:
        type: integer
        format: int32
        description: 'The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.'
    description: Fulfillment center description.
  FulfillmentCenterDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/FulfillmentCenterDescription'
    description: A collection of fulfillment center descriptions.
