{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Member Groups",
    "description": "Create and administer a collection of stores and recognized member groups.",
    "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"
          ]
        }
      }
    }
  ],
  "paths": {
    "/store-member-groups": {
      "get": {
        "tags": [
          "store-member-groups"
        ],
        "description": "Get a collection of stores and recognized member groups.",
        "operationId": "getStoreMemberGroups",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The store ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "memberGroupId",
            "in": "query",
            "description": "The member group ID.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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 stores and recognized member groups.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreMemberGroupCollection"
                }
              }
            }
          },
          "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": [
          "store-member-groups"
        ],
        "description": "Create a store and recognized member groups.",
        "operationId": "createStoreMemberGroup",
        "requestBody": {
          "description": "A store recognizes a member group as a customer group.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreMemberGroup"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the StoreMemberGroup.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreMemberGroupById": {
                "operationRef": "#/paths/~1store-member-groups~1storeId:{storeId},memberGroupId:{memberGroupId}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "memberGroupId": "$request.body#/memberGroupId"
                },
                "description": "The `storeId`,`memberGroupId` value used in the request body can be used as the `storeId`,`memberGroupId` parameter in `GET /store-member-groups/storeId:{storeId},memberGroupId:{memberGroupId}`.\n"
              },
              "DeleteStoreMemberGroupById": {
                "operationRef": "#/paths/~1store-member-groups~1storeId:{storeId},memberGroupId:{memberGroupId}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "memberGroupId": "$request.body#/memberGroupId"
                },
                "description": "The `storeId`and `memberGroupId`value used in the request body can be used as the The `storeId`, `memberGroupId` parameter in `DELETE /store-member-groups/storeId:{storeId},memberGroupId:{memberGroupId}`.\n"
              },
              "UpdateStoreMemberGroupById": {
                "operationRef": "#/paths/~1store-member-groups~1storeId:{storeId},memberGroupId:{memberGroupId}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "memberGroupId": "$request.body#/memberGroupId"
                },
                "description": "The `storeId`,`memberGroupId`  value used in the request body can be used as the `storeId`,`memberGroupId` parameter in `PATCH /store-member-groups/storeId:{storeId},memberGroupId:{memberGroupId}`.\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": "StoreMemberGroup"
      }
    },
    "/store-member-groups/storeId:{storeId},memberGroupId:{memberGroupId}": {
      "get": {
        "tags": [
          "store-member-groups"
        ],
        "description": "Get a store and recognized member groups.",
        "operationId": "getStoreMemberGroupById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "memberGroupId",
            "in": "path",
            "description": "The member group ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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 store recognizes a member group as a customer group.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreMemberGroups"
                }
              }
            }
          },
          "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": [
          "store-member-groups"
        ],
        "description": "Delete a store and recognized member groups.",
        "operationId": "deleteStoreMemberGroupById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "memberGroupId",
            "in": "path",
            "description": "The member group ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "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": [
          "store-member-groups"
        ],
        "description": "Update a store and recognized member groups.",
        "operationId": "updateStoreMemberGroupById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "memberGroupId",
            "in": "path",
            "description": "The member group ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "A store recognizes a member group as a customer group.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreMemberGroup"
              }
            }
          },
          "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": "StoreMemberGroup"
      }
    }
  },
  "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."
      },
      "StoreMemberGroup": {
        "type": "object",
        "required": [
          "storeId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store ID.",
            "format": "int32"
          },
          "memberGroupId": {
            "type": "integer",
            "description": "The member group ID.",
            "format": "int64"
          }
        },
        "description": "A store recognizes a member group as a customer group."
      },
      "StoreMemberGroups": {
        "type": "object",
        "required": [
          "storeId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store ID.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "memberGroupId": {
            "type": "integer",
            "description": "The member group ID.",
            "format": "int64"
          }
        },
        "description": "A store recognizes a member group as a customer group."
      },
      "StoreMemberGroupCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/StoreMemberGroups"
            }
          }
        },
        "description": "A collection of stores and recognized member groups."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}