{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipping Mode Descriptions",
    "version": "9.1.20.0",
    "description": "Create and administer description of shipping mode.",
    "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"
          ]
        }
      }
    }
  ],
  "paths": {
    "/shipping-mode-descriptions": {
      "get": {
        "tags": [
          "shipping-mode-descriptions"
        ],
        "description": "Get a collection of Shipping Mode Descriptions.",
        "operationId": "getShippingModeDescriptions",
        "parameters": [
          {
            "name": "shippingModeId",
            "in": "query",
            "description": "The Shipping Mode ID.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The Language ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "A brief description of the shipping mode, suitable for display to a customer for selection. For example, XYZ Carrier, Overnight shipping mode.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "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"
            }
          },
          {
            "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.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of Shipping Mode Descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingModeDescriptionCollection"
                },
                "example": {
                  "href": "https://10.190.66.207:8000/rest/admin/v2/shipping-mode-descriptions?shippingModeId=10501&shippingModeId=12501&storeId=1&languageId=-1,",
                  "count": 2,
                  "items": {
                    "shippingModeId": "10501,",
                    "languageId": "-1,",
                    "description": "Mail,",
                    "field1": "null,",
                    "field2": "Mail,",
                    "links": {
                      "self": {
                        "href": "https://10.190.66.207:8000/rest/admin/v2/shipping-mode-descriptions/languageId:-1,shippingModeId:10501"
                      }
                    }
                  }
                }
              }
            }
          },
          "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": [
          "shipping-mode-descriptions"
        ],
        "description": "Create a shipping mode description.",
        "operationId": "createShippingModeDescription",
        "requestBody": {
          "description": "A Shipping Mode Description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShippingModeDescription"
              },
              "example": {
                "shippingModeId": "10501",
                "languageId": "-1",
                "description": "International mail",
                "field1": "USD$5.00 per order plus USD$1.00 for each item",
                "field2": "5 business days"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Shipping Mode Descriptions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetShippingModeDescriptionsByLanguageIdShippingModeId": {
                "operationRef": "#/paths/~1shipping-mode-descriptions~1languageId:{languageId},shippingModeId:{shippingModeId}/get",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "shippingModeId": "$request.body#/shippingModeId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /shipping-mode-descriptions/languageId:{languageId},shippingModeId:{shippingModeId}`.\n"
              },
              "DeleteShippingModeDescriptionsByLanguageIdShippingModeId": {
                "operationRef": "#/paths/~1shipping-mode-descriptions~1languageId:{languageId},shippingModeId:{shippingModeId}/delete",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "shippingModeId": "$request.body#/shippingModeId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /shipping-mode-descriptions/languageId:{languageId},shippingModeId:{shippingModeId}`.\n"
              },
              "UpdateShippingModeDescriptionsByLanguageIdShippingModeId": {
                "operationRef": "#/paths/~1shipping-mode-descriptions~1languageId:{languageId},shippingModeId:{shippingModeId}/patch",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "shippingModeId": "$request.body#/shippingModeId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /shipping-mode-descriptions/languageId:{languageId},shippingModeId:{shippingModeId}`.\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": "ShippingModeDescription"
      }
    },
    "/shipping-mode-descriptions/languageId:{languageId},shippingModeId:{shippingModeId}": {
      "get": {
        "tags": [
          "shipping-mode-descriptions"
        ],
        "description": "Get a shipping mode description.",
        "operationId": "getShippingModeDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "shippingModeId",
            "in": "path",
            "description": "The Shipping Mode ID.",
            "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"
            }
          },
          {
            "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.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Shipping Mode Description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingModeDescription"
                },
                "example": {
                  "shippingModeId": 10501,
                  "languageId": -1,
                  "description": "Mail",
                  "field1": null,
                  "field2": "Mail",
                  "links": {
                    "self": {
                      "href": "https://10.190.66.207:8000/rest/admin/v2/shipping-mode-descriptions/languageId:-1,shippingModeId:10501"
                    }
                  }
                }
              }
            }
          },
          "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": [
          "shipping-mode-descriptions"
        ],
        "description": "Delete a shipping mode description.",
        "operationId": "deleteShippingModeDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "shippingModeId",
            "in": "path",
            "description": "The Shipping Mode ID.",
            "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": [
          "shipping-mode-descriptions"
        ],
        "description": "Update a shipping mode description.",
        "operationId": "updateShippingModeDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "shippingModeId",
            "in": "path",
            "description": "The Shipping Mode ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A Shipping Mode Description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShippingModeDescriptions"
              }
            }
          },
          "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": "ShippingModeDescription"
      }
    }
  },
  "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."
      },
      "ShippingModeDescription": {
        "type": "object",
        "properties": {
          "shippingModeId": {
            "type": "integer",
            "description": "The Shipping Mode ID.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language ID.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the shipping mode, suitable for display to a customer for selection. For example, XYZ Carrier, Overnight shipping mode."
          },
          "field1": {
            "type": "string",
            "nullable": true,
            "description": "Customizable."
          },
          "field2": {
            "type": "string",
            "description": "Customizable."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "A Shipping Mode Description."
      },
      "ShippingModeDescriptions": {
        "type": "object",
        "properties": {
          "shippingModeId": {
            "type": "integer",
            "description": "The Shipping Mode ID.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language ID.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the shipping mode, suitable for display to a customer for selection. For example, XYZ Carrier, Overnight shipping mode."
          },
          "field1": {
            "type": "string",
            "nullable": true,
            "description": "Customizable."
          },
          "field2": {
            "type": "string",
            "description": "Customizable."
          }
        },
        "description": "A Shipping Mode Description."
      },
      "ShippingModeDescriptionCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/ShippingModeDescription"
            }
          }
        },
        "description": "A collection of Shipping Mode Descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}