{
  "openapi": "3.0.1",
  "info": {
    "title": "RMA",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of RMA.",
    "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": "RMA",
      "description": "Provides RESTful services to manage RMA (returns) for an order."
    },
    {
      "name": "RMA Items",
      "description": "Provides RESTful services to manage RMA Items for an order."
    }
  ],
  "paths": {
    "/rma": {
      "get": {
        "tags": [
          "RMA"
        ],
        "summary": "Get all the RMAs based on provided parameters.",
        "description": "Get all the RMAs based on provided parameters",
        "operationId": "getAllRMA",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "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",
              "default": 0
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "csrId",
            "in": "query",
            "description": "The unique string ID for identifying the CSR user.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the RMA.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderId",
            "in": "query",
            "description": "The unique numeric ID for identifying the order.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "The status of the RMA.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rmaStartDateTime",
            "in": "query",
            "description": "The rma create start date and time.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rmaEndDateTime",
            "in": "query",
            "description": "The rma create end date and time.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rmaLastUpdateStartDateTime",
            "in": "query",
            "description": "The rma last update start date and time.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rmaLastUpdateEndDateTime",
            "in": "query",
            "description": "The rma last update end date and time.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RMACollection"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {}
          }
        }
      },
      "post": {
        "tags": [
          "RMA"
        ],
        "summary": "Create an RMA.",
        "description": "Create an RMA",
        "operationId": "createRMA",
        "requestBody": {
          "description": "Request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RMARequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The requested resource has been created.",
            "headers": {
              "Location": {
                "description": "Link to the newly created resource.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IDResponseBase"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "body"
      }
    },
    "/rma/{id}": {
      "patch": {
        "tags": [
          "RMA"
        ],
        "summary": "Update an RMA.",
        "description": "Update an RMA",
        "operationId": "updateRMA",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RMAUpdateRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "The requested resource has been updated successfully.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "body"
      },
      "get": {
        "tags": [
          "RMA"
        ],
        "summary": "Get an RMA.",
        "description": "Get an RMA by its ID",
        "operationId": "getRMAById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RMA"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {}
          }
        }
      }
    },
    "/rma/{id}/items": {
      "get": {
        "tags": [
          "RMA"
        ],
        "summary": "Get all the RMA items.",
        "description": "Get all the RMA items",
        "operationId": "getRMAItems",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RMAItemsCollection"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/rma/{id}/submit": {
      "post": {
        "tags": [
          "RMA"
        ],
        "summary": "Submit an RMA.",
        "description": "Submit an RMA",
        "operationId": "submitRMA",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The requested resource has been updated successfully.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/rma/{id}/cancel": {
      "post": {
        "tags": [
          "RMA"
        ],
        "summary": "Cancel an existing RMA.",
        "description": "Cancel an existing RMA by its ID.",
        "operationId": "cancelRMA",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The requested resource has been updated successfully.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The specified resource could not be found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/rma-items": {
      "post": {
        "tags": [
          "RMA Items"
        ],
        "summary": "Create an RMA item.",
        "description": "Create a new RMA item",
        "operationId": "createRMAItem",
        "requestBody": {
          "description": "Request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RMAItemsRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The requested resource has been created.",
            "headers": {
              "Location": {
                "description": "Link to the newly created resource.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IDResponseBase"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "body"
      }
    },
    "/rma-items/{id}/receipt": {
      "post": {
        "tags": [
          "RMA Items"
        ],
        "summary": "Receipt an RMA item.",
        "description": "Receipt an RMA item",
        "operationId": "receiveRMAItem",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA item.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body for updating an RMA item.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RMAItemsReceiptRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "The requested resource has been updated successfully.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The specified resource could not be found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "body"
      }
    },
    "/rma-items/{id}": {
      "get": {
        "tags": [
          "RMA Items"
        ],
        "summary": "Get an RMA item by ID.",
        "description": "Get an RMA item by ID",
        "operationId": "getRMAItemById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA item.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RMAItems"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {}
          }
        }
      },
      "delete": {
        "tags": [
          "RMA Items"
        ],
        "summary": "Delete an RMA item by ID.",
        "description": "Delete an RMA item by ID",
        "operationId": "deleteRMAItem",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA item.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The requested resource has been deleted.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "RMA Items"
        ],
        "summary": "Update an RMA item.",
        "description": "Update an RMA item by its ID",
        "operationId": "updateRMAItem",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the RMA item.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The request body for updating an RMA item.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RMAItemsUpdateRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "The requested resource has been updated successfully.",
            "content": {}
          },
          "400": {
            "description": "Bad request. The request could not be understood by the server due to malformed syntax.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated. The user session is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "403": {
            "description": "The user is not authorized to perform the specified request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The specified resource could not be found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error. For details, see the server log files.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "body"
      }
    }
  },
  "components": {
    "schemas": {
      "IDResponseBase": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      },
      "CollectionResponseCountBase": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The count shows total number of items.",
            "format": "int32"
          }
        }
      },
      "CollectionResponseBase": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The count shows total number of items.",
            "format": "int32"
          },
          "offset": {
            "type": "integer"
          },
          "limit": {
            "type": "integer"
          }
        }
      },
      "RMARequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMABaseProperties"
          },
          {
            "$ref": "#/components/schemas/RMAOptionalProperties"
          }
        ]
      },
      "RMAUpdateRequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAOptionalProperties"
          }
        ]
      },
      "RMA": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAAdditionalProperties"
          },
          {
            "$ref": "#/components/schemas/RMABaseProperties"
          },
          {
            "$ref": "#/components/schemas/RMAOptionalProperties"
          }
        ]
      },
      "RMACollection": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CollectionResponseBase"
          },
          {
            "$ref": "#/components/schemas/RMAResponseItems"
          }
        ]
      },
      "RMAItemsRequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAItemsBaseProperties"
          },
          {
            "$ref": "#/components/schemas/RMAItemsOptionalProperties"
          }
        ]
      },
      "RMAItemsUpdateRequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAItemsOptionalProperties"
          }
        ]
      },
      "RMAItemsReceiptRequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAItemsReceiptProperties"
          }
        ]
      },
      "RMAItems": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RMAItemsAdditionalProperties"
          },
          {
            "$ref": "#/components/schemas/RMAItemsBaseProperties"
          },
          {
            "$ref": "#/components/schemas/RMAItemsOptionalProperties"
          },
          {
            "$ref": "#/components/schemas/RMAItemsReceiptProperties"
          }
        ]
      },
      "RMAItemsCollection": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CollectionResponseCountBase"
          },
          {
            "$ref": "#/components/schemas/RMAItemsResponseItems"
          }
        ]
      },
      "RMABaseProperties": {
        "type": "object",
        "required": [
          "orderId"
        ],
        "properties": {
          "orderId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the order associated with this RMA."
          }
        }
      },
      "RMAOptionalProperties": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "A mnemonic description of the RMA, entered by the CSR, suitable for display to the customer."
          },
          "comment": {
            "type": "string",
            "description": "Comments from the CSR."
          }
        }
      },
      "RMAAdditionalProperties": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the RMA."
          },
          "csrId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the CSR who created the RMA."
          },
          "csrFirstName": {
            "type": "string",
            "description": "The first name of the CSR who created the RMA."
          },
          "csrLastName": {
            "type": "string",
            "description": "The last name of the CSR who created the RMA."
          },
          "csrLogonId": {
            "type": "string",
            "description": "The log on identifier for the CSR who created the RMA."
          },
          "status": {
            "type": "string",
            "description": "The status of the RMA.\n* 'PND' - pending\n* 'APP' - automatically approved\n* 'MAN' - manually approved\n* 'CAN' - cancel\n* 'CLS' - closed\n",
            "enum": [
              "PND",
              "APP",
              "MAN",
              "RCV",
              "CAN",
              "CLO"
            ]
          },
          "totalCredit": {
            "type": "number",
            "description": "The total credit due."
          },
          "totalTaxCredit": {
            "type": "number",
            "description": "The total tax credit due."
          },
          "field1": {
            "type": "integer",
            "description": "A customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "number",
            "description": "A customizable field."
          },
          "field3": {
            "type": "string",
            "description": "A customizable field."
          },
          "timeCreated": {
            "type": "string",
            "description": "The date and time that the RMA was created.",
            "format": "date-time"
          },
          "lastUpdated": {
            "type": "string",
            "description": "The date and time that the RMA was last updated.",
            "format": "date-time"
          }
        }
      },
      "RMAResponseItems": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RMA"
            }
          }
        }
      },
      "RMAItemsBaseProperties": {
        "type": "object",
        "required": [
          "ordReturnId",
          "orderItemId"
        ],
        "properties": {
          "ordReturnId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the RMA."
          },
          "orderItemId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the order item."
          }
        }
      },
      "RMAItemsOptionalProperties": {
        "type": "object",
        "properties": {
          "comment": {
            "type": "string",
            "description": "Comments from the CSR."
          },
          "description": {
            "type": "string",
            "description": "A mnemonic description of the RMA item, entered by the CSR, suitable for display to the customer."
          },
          "reqQty": {
            "type": "number",
            "description": "The actual requested quantity for returned, in the unit of measurement specified by quantity measure.",
            "format": "double"
          },
          "justifications": {
            "type": "array",
            "items": {
              "description": "The reason ID for the appeasement.",
              "type": "integer",
              "format": "int32"
            }
          },
          "otherJustification": {
            "type": "string",
            "description": "The other reason for the return item."
          }
        }
      },
      "RMAItemsReceiptProperties": {
        "type": "object",
        "properties": {
          "recQty": {
            "type": "number",
            "description": "The actual quantity received for requested retrun item, in the unit of measurement specified by quantity measure.",
            "format": "double"
          },
          "dateReceived": {
            "type": "string",
            "description": "The date and time that the RMA item was received at fulfillment center.",
            "format": "date-time",
            "writeOnly": true
          },
          "skipCreditRefund": {
            "type": "boolean",
            "description": "This is an optional parameter to explicitly close the return item without initiating refund.",
            "writeOnly": true
          },
          "skipUnlock": {
            "type": "boolean",
            "description": "This is an optional parameter to skip the order unlocking at the end of the return item receipt processing.",
            "writeOnly": true
          }
        }
      },
      "RMAItemsAdditionalProperties": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the RMA item.",
            "readOnly": true
          },
          "status": {
            "type": "string",
            "description": "The status of the RMA.\n* 'PND' - pending\n* 'APP' - automatically approved\n* 'MAN' - manually approved\n* 'CAN' - cancel\n* 'CLS' - closed\n",
            "enum": [
              "PND",
              "APP",
              "MAN",
              "RCV",
              "CAN",
              "CLO"
            ],
            "readOnly": true
          },
          "csrId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the user (CSR) who created the RMA.",
            "readOnly": true
          },
          "csrFirstName": {
            "type": "string",
            "description": "The first name of the CSR who created the RMA."
          },
          "csrLastName": {
            "type": "string",
            "description": "The last name of the CSR who created the RMA."
          },
          "csrLogonId": {
            "type": "string",
            "description": "The log on identifier for the CSR who created the RMA."
          },
          "creditAmount": {
            "type": "number",
            "description": "The credit amount.",
            "readOnly": true
          },
          "taxAmount": {
            "type": "number",
            "description": "The date and time that the RMA was last updated.",
            "readOnly": true
          },
          "totalCredit": {
            "type": "number",
            "description": "The total credit amount.",
            "readOnly": true
          },
          "field1": {
            "type": "integer",
            "description": "A customizable field.",
            "format": "int32",
            "readOnly": true
          },
          "field2": {
            "type": "number",
            "description": "A customizable field.",
            "readOnly": true
          },
          "field3": {
            "type": "string",
            "description": "A customizable field.",
            "readOnly": true
          },
          "timeCreated": {
            "type": "string",
            "description": "The date and time that the RMA item was created.",
            "format": "date-time",
            "readOnly": true
          },
          "lastUpdated": {
            "type": "string",
            "description": "The date and time that the RMA item was last updated.",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "RMAItemsResponseItems": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RMAItems"
            }
          }
        }
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          },
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          }
        },
        "description": "The error message model."
      },
      "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."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}