{
  "openapi": "3.0.1",
  "info": {
    "title": "Catalog Group Calculation Codes",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of relationships between catalog groups and calculation codes.",
    "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": "Catalog Group Calculation Codes",
      "description": "Provide RESTful services to manage catalog group calculation codes."
    }
  ],
  "paths": {
    "/catalog-group-calculation-codes": {
      "get": {
        "tags": [
          "Catalog Group Calculation Codes"
        ],
        "description": "Get a collection of relationships between catalog groups and calculation codes.",
        "operationId": "getCatalogGroupCalculationCodes",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The store ID that is associated with the relationship between the catalog group and the calculation code.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "catalogGroupId",
            "in": "query",
            "description": "The catalog group id.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "calculationCodeId",
            "in": "query",
            "description": "The calculation code id.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the relationship between the catalog group and the calculation code.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tradingId",
            "in": "query",
            "description": "The trading agreement id.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "calculationFlags",
            "in": "query",
            "description": "The flags for the relationship between the catalog group and the calculation code.",
            "schema": {
              "type": "number"
            }
          },
          {
            "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 relationships between catalog groups and calculation codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogGroupCalculationCodeCollection"
                }
              }
            }
          },
          "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": [
          "Catalog Group Calculation Codes"
        ],
        "description": "Create a relationship between a catalog group and a calculation code.",
        "operationId": "createCatalogGroupCalculationCode",
        "requestBody": {
          "description": "The relationship between a catalog group and a calculation code.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CatalogGroupCalculationCode"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "links": {
              "GetCatalogGroupCalculationCodeById": {
                "operationRef": "#/paths/~1catalog-group-calculation-codes~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /catalog-group-calculation-codes/{id}`.\n"
              },
              "DeleteCatalogGroupCalculationCodeById": {
                "operationRef": "#/paths/~1catalog-group-calculation-codes~1/{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE/catalog-group-calculation-codes/{id}`.\n"
              },
              "UpdateCatalogGroupCalculationCodeById": {
                "operationRef": "#/paths/~1catalog-group-calculation-codes~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id`value used in the request body can be used as the `id` parameter in `PATCH/catalog-group-calculation-codes/{id}`.\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": "CatalogGroupCalculationCode"
      }
    },
    "/catalog-group-calculation-codes/{id}": {
      "get": {
        "tags": [
          "Catalog Group Calculation Codes"
        ],
        "description": "Get a relationship between a catalog group and a calculation code.",
        "operationId": "getCatalogGroupCalculationCodeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the relationship between the catalog group and the calculation code.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "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": "The relationship between a catalog group and a calculation code.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogGroupCalculationCode"
                }
              }
            }
          },
          "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": [
          "Catalog Group Calculation Codes"
        ],
        "description": "Delete a relationship between a catalog group and a calculation code.",
        "operationId": "deleteCatalogGroupCalculationCodeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the relationship between the catalog group and the calculation code.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "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": [
          "Catalog Group Calculation Codes"
        ],
        "description": "Update a relationship between a catalog group and a calculation code.",
        "operationId": "updateCatalogGroupCalculationCodeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the relationship between the catalog group and the calculation code.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The relationship between a catalog group and a calculation code.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CatalogGroupCalculationCode"
              }
            }
          },
          "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": "CatalogGroupCalculationCode"
      }
    }
  },
  "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."
      },
      "CatalogGroupCalculationCode": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store ID that is associated with the relationship between the catalog group and the calculation code.",
            "format": "int32"
          },
          "catalogGroupId": {
            "type": "string",
            "description": "The catalog group id."
          },
          "calculationCodeId": {
            "type": "integer",
            "description": "The calculation code id.",
            "format": "int32"
          },
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the relationship between the catalog group and the calculation code."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "tradingId": {
            "type": "string",
            "description": "The trading agreement id."
          },
          "calculationFlags": {
            "type": "number",
            "description": "The flags for the relationship between the catalog group and the calculation code."
          }
        },
        "description": "The relationship between a catalog group and a calculation code."
      },
      "CatalogGroupCalculationCodeCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/CatalogGroupCalculationCode"
            }
          }
        },
        "description": "A collection of relationships between catalog groups and calculation codes."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}