{
  "openapi": "3.0.1",
  "info": {
    "title": "Online Stores",
    "version": "9.1.20.0",
    "description": "Create and administer online stores.",
    "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": "Online Stores",
      "description": "Provide RESTful services to manage online stores."
    }
  ],
  "paths": {
    "/online-stores": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Get a collection of online stores.",
        "operationId": "getOnlineStores",
        "parameters": [
          {
            "name": "usage",
            "in": "query",
            "description": "The usage, example value of usage=IBM_StoreManagementTool",
            "required": false,
            "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",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          },
          {
            "name": "searchString",
            "in": "query",
            "description": "Limits search results to only include stores with an identifier that matches the value of this parameter.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ownerId",
            "in": "query",
            "description": "Limits search results to only include stores with a matching ownerId.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore"
          }
        },
        "x-expression-template": "{_wcf.ap='IBM_Admin_All';_wcf.usage='{usage}'}/OnlineStore",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    },
    "/online-stores/by-identifier": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets online stores by identifier.",
        "operationId": "getOnlineStoresByIdentifier",
        "parameters": [
          {
            "name": "usage",
            "in": "query",
            "description": "The usage, exmaple value of usage=IBM_StoreManagementTool.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "identifier",
            "in": "query",
            "description": "The identifier or name for identifying the online store.",
            "required": true,
            "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",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore"
          }
        },
        "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All",
          "template": "{_wcf.usage='$usage$'}/OnlineStore[search(StoreIdentifier/ExternalIdentifier/NameIdentifier='$identifier$')]"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    },
    "/online-stores/by-related-store-id": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Get a collection of online stores by related store ID.",
        "operationId": "getOnlineStoresByRelatedStoreId",
        "parameters": [
          {
            "name": "usage",
            "in": "query",
            "description": "The usage, exmaple value of usage=IBM_StoreManagementTool..",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "relatedStoreId",
            "in": "query",
            "description": "The unique numeric ID of the related online store. The returned online stores are related to this online 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",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.usage='{usage}'}/OnlineStore[OnlineStoreRelatedStores[StoreIdentifier[(UniqueID='{relatedStoreId}')]]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    },
    "/online-stores/{id}": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store by online store ID.",
        "operationId": "getOnlineStore",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStore"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    },
    "/online-stores/{id}/close": {
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Closes an online store.",
        "operationId": "closeOnlineStore",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Close",
        "x-expression-template": "/OnlineStore[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "processOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ProcessOnlineStoreType"
      }
    },
    "/online-stores/{id}/open": {
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Opens an online store.",
        "operationId": "openOnlineStore",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Open",
        "x-expression-template": "/OnlineStore[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "processOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ProcessOnlineStoreType"
      }
    },
    "/online-stores/{onlineStoreId}/configuration-values": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store's configuration values.",
        "operationId": "getOnlineStoreConfigurationValues",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreConfigurationValues"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/userData"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    },
    "/online-stores/{onlineStoreId}/contacts": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets the online store contact information.",
        "operationId": "getOnlineStoreContacts",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "required": true,
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreContactCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Creates an online store contact.",
        "operationId": "createOnlineStoreContact",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreContact"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the contact.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo[1]/contactInfoIdentifier/uniqueID",
            "links": {
              "getOnlineStoreContacts": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1contacts/get",
                "parameters": {
                  "onlineStoreId ": "$request.path.onlineStoreId",
                  "dataLanguageIds": "$request.body#/languageId "
                },
                "description": "The `onlineStoreId`,`dataLanguageIds` value used in the request body can be used as the `onlineStoreId`,`dataLanguageIds` parameter in `GET /online-stores/{onlineStoreId}/contacts`.\n"
              },
              "deleteOnlineStoreContact": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1contacts~1{id}/delete",
                "parameters": {
                  "id": "$response.header.Location",
                  "onlineStoreId ": "$request.path.onlineStoreId"
                },
                "description": "The `id`and `onlineStoreId`value used in the request body can be used as the The `id`and `onlineStoreId` parameter in `DELETE /online-stores/{onlineStoreId}/contacts/{id}`.\n"
              },
              "updateOnlineStoreContact": {
                "operationRef": "#/paths/~1/online-stores~1{onlineStoreId}~1contacts~1{id}/patch",
                "parameters": {
                  "id": "$response.header.Location",
                  "onlineStoreId ": "$request.path.onlineStoreId"
                },
                "description": "The `id`, `onlineStoreId`  value used in the request body can be used as the `id`and  `onlineStoreId` parameter in `PATCH /online-stores/{onlineStoreId}/contacts/{id}`.\n"
              }
            }
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreContactInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/contacts/{id}": {
      "delete": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Deletes an online store contact.",
        "operationId": "deleteOnlineStoreContact",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying online store contact ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo[1]/contactInfoIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo[1]/contactInfoIdentifier/uniqueID"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreContactInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change"
      },
      "patch": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Updates an online store contact.",
        "operationId": "updateOnlineStoreContact",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying online store contact ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo[1]/contactInfoIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreContactInfo[1]/contactInfoIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreContact"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreContactInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/currencies": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Get an online store's currencies.",
        "operationId": "getOnlineStoreCurrencies",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreCurrencies"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreSupportedCurrencies[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "patch": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Updates an online store's currencies.",
        "operationId": "updateOnlineStoreCurrencies",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreCurrencies"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/OnlineStore[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/default-catalogs": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store's default catalogs.",
        "operationId": "getOnlineStoreDefaultCatalogs",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreDefaultCatalogCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/defaultCatalog"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Create a default catalog for an online store.",
        "operationId": "createOnlineStoreDefaultCatalog",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreDefaultCatalog"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the default catalog.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/onlineStore[1]/defaultCatalog[1]/uniqueID",
            "links": {
              "GetOnlineStoreDefaultCatalog": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1default-catalogs/get",
                "parameters": {
                  "onlineStoreId": "$request.path.onlineStoreId"
                },
                "description": "The `onlineStoreId` value used in the request body can be used as the `onlineStoreId` parameter in `GET /online-stores/{onlineStoreId}/default-catalogs`.\n"
              },
              "DeleteOnlineStoreDefaultCatalog": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1default-catalogs~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/catalogId",
                  "onlineStoreId": "$request.path.onlineStoreId"
                },
                "description": "The `id`,`onlineStoreId`value used in the request body can be used as the The `id`,`onlineStoreId` parameter in `DELETE /online-stores/{onlineStoreId}/default-catalogs/{id}`.\n"
              }
            }
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/OnlineStore[1]/DefaultCatalog[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/default-catalogs/{id}": {
      "delete": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Delete the default catalog of an online store.",
        "operationId": "deleteOnlineStoreDefaultCatalog",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the default catalog.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/onlineStore[1]/defaultCatalog[1]/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/defaultCatalog[1]/uniqueID"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/OnlineStore[1]/DefaultCatalog[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change"
      }
    },
    "/online-stores/{onlineStoreId}/descriptions": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets the online store descriptions.",
        "operationId": "getOnlineStoreDescriptions",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "required": true,
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreDescriptionCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreDescription"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Create a description for an online store.",
        "operationId": "createOnlineStoreDescription",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the online store description.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreDescription[1]/language",
            "links": {
              "getOnlineStoreDescription": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1descriptions~1{id}/get",
                "parameters": {
                  "onlineStoreId": "$request.path.onlineStoreId",
                  "dataLanguageIds": "$request.body#/id"
                },
                "description": "The `onlineStoreId`&`dataLanguageIds` value used in the request body can be used as the `onlineStoreId`&`dataLanguageIds` parameter in `GET /online-stores/{onlineStoreId}/descriptions/{id}`.\n"
              },
              "updateOnlineStoreDescription": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1descriptions~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id",
                  "onlineStoreId": "$request.path.onlineStoreId"
                },
                "description": "The `id`and `onlineStoreId`value used in the request body can be used as the The `id`and `onlineStoreId` parameter in `PATCH/online-stores/{onlineStoreId}/descriptions/{id}`.\n"
              }
            }
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreDescription[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/descriptions/{id}": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store description.",
        "operationId": "getOnlineStoreDescription",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The integer for identifying the language of the description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreDescription"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreDescription[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{id}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "patch": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Updates an online store description.",
        "operationId": "updateOnlineStoreDescription",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The integer for identifying the language of the description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreDescription[1]/language"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreDescription[1]/language"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreDescription[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/languages": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store's languages.",
        "operationId": "getOnlineStoreLanguages",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreLanguages"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreSupportedLanguages[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "patch": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Updates an online store's languages.",
        "operationId": "updateOnlineStoreLanguages",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreLanguages"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/OnlineStore[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/locations": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets the online store location information.",
        "operationId": "getOnlineStoreLocations",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "required": true,
            "description": "The data language IDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreLocationCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      },
      "post": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Creates an online store location.",
        "operationId": "createOnlineStoreLocation",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreLocation"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the location.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {},
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo[1]/contactInfoIdentifier/uniqueID",
            "links": {
              "GetOnlineStoreLocations": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1locations/get",
                "parameters": {
                  "onlineStoreId": "$request.path.onlineStoreId",
                  "dataLanguageIds": "$request.body#/languageId "
                },
                "description": "The `onlineStoreId`,`dataLanguageIds` value used in the request body can be used as the `onlineStoreId`,`dataLanguageIds` parameter in `GET /online-stores/{onlineStoreId}/locations`.\n"
              },
              "DeleteOnlineStoreLocation": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1locations~1{id}/delete",
                "parameters": {
                  "id": "$response.header.Location",
                  "onlineStoreId": "$request.path.onlineStoreId"
                },
                "description": "The `id`and `onlineStoreId`value used in the request body can be used as the The `id`and `onlineStoreId` parameter in `DELETE ​/online-stores​/{onlineStoreId}​/locations​/{id}`.\n"
              },
              "UpdateOnlineStoreLocation": {
                "operationRef": "#/paths/~1online-stores~1{onlineStoreId}~1locations~1{id}/patch",
                "parameters": {
                  "id": "$response.header.Location",
                  "onlineStoreId": "$request.path.onlineStoreId"
                },
                "description": "The `id`,`onlineStoreId`  value used in the request body can be used as the `id`,`onlineStoreId` parameter in `PATCH /online-stores​/{onlineStoreId}​/locations​/{id}`.\n"
              }
            }
          }
        },
        "x-action-code": "Add",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreLocationInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/locations/{id}": {
      "delete": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Deletes an online store location.",
        "operationId": "deleteOnlineStoreLocation",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying online store location ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo[1]/contactInfoIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo[1]/contactInfoIdentifier/uniqueID"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreLocationInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change"
      },
      "patch": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Updates an online store location.",
        "operationId": "updateOnlineStoreLocation",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying online store location ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo[1]/contactInfoIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreLocationInfo[1]/contactInfoIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnlineStoreLocation"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/OnlineStore[1]/OnlineStoreLocationInfo[1]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "changeOnlineStore",
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    },
    "/online-stores/{onlineStoreId}/related-stores": {
      "get": {
        "tags": [
          "Online Stores"
        ],
        "summary": "Gets an online store's related stores.",
        "operationId": "getOnlineStoreRelatedStores",
        "parameters": [
          {
            "name": "onlineStoreId",
            "in": "path",
            "description": "The unique numeric ID for identifying the online store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnlineStoreRelatedStoreCollection"
                }
              }
            },
            "x-entity-path": "dataArea/onlineStore[1]/onlineStoreRelatedStores"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}'}/OnlineStore[StoreIdentifier[(UniqueID='{onlineStoreId}')]]",
        "x-facade-client-class": "com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient",
        "x-facade-client-method": "getOnlineStore",
        "x-parameters": {
          "accessProfile": "IBM_Admin_All"
        },
        "x-request-bod-class": "com.ibm.commerce.infrastructure.facade.datatypes.GetOnlineStoreType"
      }
    }
  },
  "components": {
    "schemas": {
      "OnlineStore": {
        "type": "object",
        "required": [
          "id",
          "ownerId",
          "identifier"
        ],
        "properties": {
          "catalogOverrideEnabled": {
            "type": "string",
            "description": "The catalog override enabled value configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/isCatalogOverrideEnabled"
          },
          "externalContentEnablementMode": {
            "type": "string",
            "description": "The external content enablement value configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/externalContentEnablementMode"
          },
          "externalContentHostName": {
            "type": "string",
            "description": "The external content host name configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContent.hostName"
          },
          "externalContentPickerUrl": {
            "type": "string",
            "description": "The external content picker URL configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContent.pickerURL"
          },
          "externalContentDAMFilePickerUrl": {
            "type": "string",
            "description": "The external content picker URL configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContentDam.pickerURL"
          },
          "externalContentDAMImagePickerUrl": {
            "type": "string",
            "description": "The external content picker URL configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContentDamImage.pickerURL"
          },
          "externalContentAPIContextRoot": {
            "type": "string",
            "description": "The external content picker URL configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContentAPIContextRoot"
          },
          "externalContentAPIContentPath": {
            "type": "string",
            "description": "The external content picker URL configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContentDamImage.pickerURL"
          },
          "externalContentTenantId": {
            "type": "string",
            "description": "The external content tenant ID configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContent.tenant-id"
          },
          "externalContentUiContextRoot": {
            "type": "string",
            "description": "The external content UI context root configured for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/wc.externalContent.UIContextRoot"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "onlineStoreIdentifier/uniqueID"
          },
          "identifier": {
            "type": "string",
            "description": "The identifier or name for identifying the online store.",
            "readOnly": true,
            "x-entity-path": "onlineStoreIdentifier/externalIdentifier/nameIdentifier"
          },
          "ownerId": {
            "type": "string",
            "description": "The unique numeric ID of the organization that owns the online store.",
            "readOnly": true,
            "x-entity-path": "onlineStoreIdentifier/externalIdentifier/ownerID"
          },
          "state": {
            "type": "string",
            "description": "The state of the online store. Valid values are 'open' and 'closed'.",
            "readOnly": true,
            "x-entity-path": "state"
          },
          "type": {
            "type": "string",
            "description": "The online store type.",
            "readOnly": true,
            "x-entity-path": "storeType"
          },
          "imagePathFilter": {
            "type": "string",
            "description": "The online store image path filter.",
            "readOnly": true,
            "x-entity-path": "imagePathFilter"
          },
          "hclImagePath": {
            "type": "string",
            "description": "The online store Image path.",
            "readOnly": true,
            "x-entity-path": "imagePathFilter"
          },
          "headlessStore": {
            "type": "string",
            "description": "The online headlessStore.",
            "readOnly": true,
            "x-entity-path": "headlessStore"
          },
          "headlessStoreContextRoot": {
            "type": "string",
            "description": "The online store headlessStoreContextRoot.",
            "readOnly": true,
            "x-entity-path": "headlessStoreContextRoot"
          },
          "headlessStorePreviewHost": {
            "type": "string",
            "description": "The online store headlessStorePreviewHost.",
            "readOnly": true,
            "x-entity-path": "headlessStorePreviewHost"
          },
          "unregisterMarketingEvent": {
            "type": "string",
            "description": "The unregister marketing event configuration value for the online store.",
            "readOnly": true,
            "x-entity-path": "userData/userDataField/unregisterMarketingEvent"
          }
        },
        "description": "An online store.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.OnlineStoreType"
      },
      "OnlineStoreCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStore"
            }
          }
        },
        "description": "A collection of online stores."
      },
      "OnlineStoreConfigurationValues": {
        "type": "object",
        "required": [
          "onlineStoreId"
        ],
        "properties": {
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          },
          "values": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The set of configuration values for the online store.",
            "readOnly": true,
            "x-entity-path": "userDataField"
          }
        },
        "description": "An online store's configuration values.",
        "x-entity-class": "com.ibm.commerce.foundation.common.datatypes.UserDataType"
      },
      "OnlineStoreContact": {
        "type": "object",
        "required": [
          "country",
          "id",
          "name",
          "onlineStoreId"
        ],
        "properties": {
          "addressLine1": {
            "type": "string",
            "nullable": true,
            "description": "First address line.",
            "x-entity-path": "address/addressLine[1]"
          },
          "addressLine2": {
            "type": "string",
            "nullable": true,
            "description": "Second address line.",
            "x-entity-path": "address/addressLine[2]"
          },
          "addressLine3": {
            "type": "string",
            "nullable": true,
            "description": "Third address line.",
            "x-entity-path": "address/addressLine[3]"
          },
          "city": {
            "type": "string",
            "description": "City.",
            "x-entity-path": "address/city"
          },
          "country": {
            "type": "string",
            "description": "Country.",
            "x-entity-path": "address/country"
          },
          "email1": {
            "type": "string",
            "description": "Primary e-mail address.",
            "x-entity-path": "emailAddress1/value"
          },
          "email2": {
            "type": "string",
            "nullable": true,
            "description": "Secondary e-mail address.",
            "x-entity-path": "emailAddress2/value"
          },
          "fax1": {
            "type": "string",
            "description": "Primary fax number.",
            "nullable": true,
            "x-entity-path": "fax1/value"
          },
          "fax2": {
            "type": "string",
            "description": "Secondary fax number.",
            "nullable": true,
            "x-entity-path": "fax2/value"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store contact.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "contactInfoIdentifier/uniqueID"
          },
          "languageId": {
            "type": "integer",
            "description": "The integer for identifying the language of the online store contact. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "format": "int32",
            "x-entity-path": "language"
          },
          "name": {
            "type": "string",
            "description": "The name of the online store contact.",
            "x-entity-path": "contactName/businessTitle"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          },
          "phone1": {
            "type": "string",
            "description": "Primary telephone number.",
            "nullable": true,
            "x-entity-path": "telephone1/value"
          },
          "phone2": {
            "type": "string",
            "nullable": true,
            "description": "Secondary telephone number.",
            "x-entity-path": "telephone2/value"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code.",
            "nullable": true,
            "x-entity-path": "address/postalCode"
          },
          "stateOrProvince": {
            "type": "string",
            "description": "State or province.",
            "x-entity-path": "address/stateOrProvinceName"
          }
        },
        "description": "An online store contact.",
        "x-entity-class": "com.ibm.commerce.foundation.common.datatypes.ContactInfoType"
      },
      "OnlineStoreContactCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStoreContact"
            }
          }
        },
        "description": "A collection of online store contacts."
      },
      "OnlineStoreCurrencies": {
        "type": "object",
        "properties": {
          "currencies": {
            "type": "array",
            "description": "An array containing the currencies that are supported by the online store.",
            "items": {
              "type": "string"
            },
            "x-entity-path": "supportedCurrencies"
          },
          "defaultCurrency": {
            "type": "string",
            "description": "The default currency of the online store.",
            "x-entity-path": "defaultCurrency"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          }
        },
        "description": "An online store's supported currencies.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.OnlineStoreSupportedCurrenciesType"
      },
      "OnlineStoreDefaultCatalog": {
        "type": "object",
        "required": [
          "catalogId",
          "id",
          "storeId"
        ],
        "properties": {
          "catalogId": {
            "type": "string",
            "description": "The unique numeric ID of the catalog associated with the default catalog.",
            "x-entity-path": "catalogIdentifier/uniqueID"
          },
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the online store default catalog.",
            "readOnly": true,
            "x-entity-path": "uniqueID"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          },
          "storeId": {
            "type": "integer",
            "description": "The unique numeric ID of the store associated with the default catalog.",
            "format": "int32",
            "x-entity-path": "storeIdentifier/uniqueID"
          }
        },
        "description": "An online store default catalog.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType"
      },
      "OnlineStoreDefaultCatalogCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStoreDefaultCatalog"
            }
          }
        },
        "description": "A collection of online store default catalogs."
      },
      "OnlineStoreDescription": {
        "type": "object",
        "required": [
          "id",
          "name",
          "description"
        ],
        "properties": {
          "description": {
            "type": "string",
            "description": "The online store description."
          },
          "id": {
            "type": "integer",
            "description": "The language ID of the online store description.",
            "format": "int32",
            "x-entity-path": "language"
          },
          "name": {
            "type": "string",
            "description": "The name of the online store.",
            "x-entity-path": "displayName"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          }
        },
        "description": "An online store description.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.OnlineStoreDescriptionType"
      },
      "OnlineStoreDescriptionCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStoreDescription"
            }
          }
        },
        "description": "A collection of online store descriptions."
      },
      "OnlineStoreLanguages": {
        "type": "object",
        "required": [
          "onlineStoreId",
          "languageIds"
        ],
        "properties": {
          "defaultLanguageId": {
            "type": "integer",
            "description": "The integer for identifying the default language of the online store. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "format": "int32",
            "x-entity-path": "defaultLanguage"
          },
          "languageIds": {
            "type": "array",
            "description": "An array containing the integers for identifying the languages that are supported by the online store. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "x-entity-path": "supportedLanguages"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          }
        },
        "description": "An online store's supported languages.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.OnlineStoreSupportedLanguagesType"
      },
      "OnlineStoreLocation": {
        "type": "object",
        "properties": {
          "addressLine1": {
            "type": "string",
            "description": "First address line.",
            "x-entity-path": "address/addressLine[1]"
          },
          "addressLine2": {
            "type": "string",
            "nullable": true,
            "description": "Second address line.",
            "x-entity-path": "address/addressLine[2]"
          },
          "addressLine3": {
            "type": "string",
            "nullable": true,
            "description": "Third address line.",
            "x-entity-path": "address/addressLine[3]"
          },
          "city": {
            "type": "string",
            "description": "City.",
            "x-entity-path": "address/city"
          },
          "country": {
            "type": "string",
            "description": "Country.",
            "x-entity-path": "address/country"
          },
          "email1": {
            "type": "string",
            "description": "Primary e-mail address.",
            "x-entity-path": "emailAddress1/value"
          },
          "email2": {
            "type": "string",
            "nullable": true,
            "description": "Secondary e-mail address.",
            "x-entity-path": "emailAddress2/value"
          },
          "fax1": {
            "type": "string",
            "nullable": true,
            "description": "Primary fax number.",
            "x-entity-path": "fax1/value"
          },
          "fax2": {
            "type": "string",
            "nullable": true,
            "description": "Secondary fax number.",
            "x-entity-path": "fax2/value"
          },
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store location.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "contactInfoIdentifier/uniqueID"
          },
          "languageId": {
            "type": "integer",
            "description": "The integer for identifying the language of the online store location. For a list of the integers that map to the supported default languages, refer to the Knowledge Center.",
            "format": "int32",
            "x-entity-path": "language"
          },
          "name": {
            "type": "string",
            "description": "Store location name.",
            "x-entity-path": "contactName/businessTitle"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          },
          "phone1": {
            "type": "string",
            "description": "Primary phone number.",
            "x-entity-path": "telephone1/value"
          },
          "phone2": {
            "type": "string",
            "description": "Secondary phone number.",
            "nullable": true,
            "x-entity-path": "telephone2/value"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code.",
            "x-entity-path": "address/postalCode"
          },
          "stateOrProvince": {
            "type": "string",
            "description": "State or province.",
            "x-entity-path": "address/stateOrProvinceName"
          }
        },
        "description": "An online store location.",
        "x-entity-class": "com.ibm.commerce.foundation.common.datatypes.ContactInfoType"
      },
      "OnlineStoreLocationCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStoreContact"
            }
          }
        },
        "description": "A collection of online store contacts."
      },
      "OnlineStoreRelatedStore": {
        "type": "object",
        "required": [
          "id",
          "onlineStoreId",
          "relationshipTypeId"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store relationship.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "storeIdentifier/uniqueID"
          },
          "onlineStoreId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the online store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "container/onlineStoreIdentifier/uniqueID"
          },
          "relationshipTypeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the store relationship type.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "relationshipType"
          },
          "sequence": {
            "type": "number",
            "description": "The store relationship sequence number.",
            "format": "double",
            "readOnly": true,
            "x-entity-path": "relationshipSequence"
          },
          "state": {
            "type": "integer",
            "description": "The store relationship state. 1 indicates active. 0 indicates inactive.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "state"
          }
        },
        "description": "An online store related stores.",
        "x-entity-class": "com.ibm.commerce.infrastructure.facade.datatypes.OnlineStoreRelatedStoresType"
      },
      "OnlineStoreRelatedStoreCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of item records that match the query parameters.",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "description": "The data objects or resources that that match the query parameters.",
            "items": {
              "$ref": "#/components/schemas/OnlineStoreRelatedStore"
            }
          }
        },
        "description": "A collection of online store related stores."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}