{
  "openapi": "3.0.1",
  "info": {
    "title": "Fulfillment Center Descriptions",
    "description": "Create and administer a collection of fulfillment center descriptions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Fulfillment Center Descriptions",
      "description": "Provide RESTful services to manage fulfillment center descriptions."
    }
  ],
  "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.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "displayName",
            "in": "query",
            "description": "A string that, along with its language Id, uniquely identifies this fulfillment center.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The fulfillment center description in the language.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeAddressId",
            "in": "query",
            "description": "The physical location of the FulfillmentCenter.",
            "schema": {
              "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.",
            "schema": {
              "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.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "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.",
            "schema": {
              "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.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of fulfillment center descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfillmentCenterDescriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Fulfillment Center Descriptions"
        ],
        "description": "Create a fulfillment description.",
        "operationId": "createFulfillmentCenterDescription",
        "requestBody": {
          "description": "Fulfillment center description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FulfillmentCenterDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Fulfilment-CenterDescription.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetFulfillmentCentersDescriptionByFulfillmentCentersIdandLanguageId": {
                "operationRef": "#/paths/~1fulfillment-center-descriptions~1fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}/get",
                "parameters": {
                  "fulfillmentCenterId": "request.body#/fulfillmentCenterId",
                  "languageId": "request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /fulfillment-center-descriptions/fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}`.\n"
              },
              "DeleteFulfillmentCentersDescriptionByFulfillmentCentersIdandLanguageId": {
                "operationRef": "#/paths/~1fulfillment-center-descriptions~1fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}/delete",
                "parameters": {
                  "fulfillmentCenterId": "request.body#/fulfillmentCenterId",
                  "languageId": "request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /fulfillment-center-descriptions/fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}`.\n"
              },
              "UpdateFulfillmentCentersDescriptionByFulfillmentCentersIdandLanguageId": {
                "operationRef": "#/paths/~1fulfillment-center-descriptions~1fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}/patch",
                "parameters": {
                  "fulfillmentCenterId": "request.body#/fulfillmentCenterId",
                  "languageId": "request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /fulfillment-center-descriptions/fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "FulfillmentCenterDescription"
      }
    },
    "/fulfillment-center-descriptions/fulfillmentCenterId:{fulfillmentCenterId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Fulfillment Center Descriptions"
        ],
        "description": "Get a fulfillment description.",
        "operationId": "getFulfillmentCenterDescriptionById",
        "parameters": [
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center ID.",
            "required": true,
            "schema": {
              "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,
            "schema": {
              "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.",
            "schema": {
              "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.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Fulfillment center description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfillmentCenterDescription"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Fulfillment Center Descriptions"
        ],
        "description": "Delete a fulfillment description.",
        "operationId": "deleteFulfillmentCenterDescriptionById",
        "parameters": [
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center ID.",
            "required": true,
            "schema": {
              "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,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Fulfillment Center Descriptions"
        ],
        "description": "Update a fulfillment description.",
        "operationId": "updateFulfillmentCenterDescriptionById",
        "parameters": [
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center ID.",
            "required": true,
            "schema": {
              "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,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Fulfillment center description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FulfillmentCenterDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "FulfillmentCenterDescription"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "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": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "FulfillmentCenterDescription": {
        "type": "object",
        "properties": {
          "fulfillmentCenterId": {
            "type": "integer"
          },
          "displayName": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "storeAddressId": {
            "type": "string"
          },
          "languageId": {
            "type": "integer"
          }
        },
        "required": [
          "fulfillmentCenterId",
          "displayName",
          "languageId"
        ]
      },
      "FulfillmentCenterDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fulfillmentCenterId": {
                  "type": "integer"
                },
                "displayName": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "storeAddressId": {
                  "type": "string"
                },
                "languageId": {
                  "type": "integer"
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "self": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    }
                  },
                  "required": [
                    "self"
                  ]
                }
              },
              "required": [
                "fulfillmentCenterId",
                "displayName",
                "description",
                "storeAddressId",
                "languageId",
                "links"
              ]
            }
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "href",
          "items",
          "count"
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}