{ "openapi": "3.0.1", "info": { "title": "Marketplace Seller Management", "version": "9.1.20.0", "description": "

Create and administer marketplace seller onboarding resources.

Please note that these APIs are introduced in HCL Commerce V9.1.11.

", "x-introduced": "9.1.11.0" }, "servers": [ { "url": "https://{hostname}:{port}/rest/admin/v2", "variables": { "port": { "default": "443", "enum": [ "443", "8000" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hostname" ] } } } ], "paths": { "/marketplace-sellers": { "get": { "tags": [ "Marketplace Seller" ], "summary": "Get marketplace sellers.", "description": "Get marketplace sellers based on store ID or store type. Store ID takes precedence over store type.", "operationId": "getMarketplaceSellers", "parameters": [ { "name": "id", "in": "query", "description": "The seller organization ID.", "required": false, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The store ID.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "storeType", "in": "query", "description": "The store type.", "required": false, "schema": { "type": "string", "enum": [ "catalogAssetStore", "eSite", "b2bESite", "b2cESite" ] } }, { "name": "searchString", "in": "query", "description": "Limits the results to those that match the specified search string.", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The comma-separated set of properties that control the order of the listed items. Properties can be prefixed by either (-) to sort in descending order, or (+) to sort in ascending order. By default, properties are sorted in ascending order. For example, sort=organizationName will order the items based on the organizationName value in ascending order.
Available values for sort parameter: organizationName, storeIdentifier, status, onlineStatus, lastUpdated", "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", "default": 0 } }, { "name": "limit", "in": "query", "description": "The maximum number of records to return.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The sellers with store details are retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerCollection" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "post": { "tags": [ "Marketplace Seller" ], "summary": "Create marketplace seller store details.", "description": "Create marketplace seller store details.", "operationId": "createMarketplaceSeller", "requestBody": { "description": "Marketplace seller store details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seller_create_request" }, "example": { "id": 7000000000000007000, "storeId": 12001, "status": 0, "onlineStatus": 0 } } }, "required": true }, "responses": { "201": { "description": "The seller store details are created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seller_create_request" } } }, "headers": { "Location": { "description": "The URI of the seller store details.", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/marketplace-sellers/{id}": { "get": { "summary": "Get the marketplace seller store details by ID.", "description": "Get the marketplace seller store details by organization ID and store ID.", "operationId": "getMarketplaceSeller", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The seller store details were retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seller_response" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "tags": [ "Marketplace Seller" ] }, "patch": { "summary": "Update the marketplace seller store details.", "description": "Update the marketplace seller store details.", "operationId": "updateMarketplaceSeller", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store. If no store is specified, the updates will be applied to all stores.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seller_update_request" }, "examples": { "status": { "summary": "Marketplace Operator updates seller status", "value": { "status": 1 } }, "online": { "summary": "Marketplace Operator updates seller online status", "value": { "onlineStatus": 1 } } } } }, "required": true }, "responses": { "204": { "description": "The seller store details were updated successfully.", "content": {} }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "tags": [ "Marketplace Seller" ] }, "delete": { "summary": "Remove the marketplace seller from a store.", "description": "Remove the marketplace seller from a store.", "operationId": "deleteMarketplaceSeller", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The seller was removed from the store successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "tags": [ "Marketplace Seller" ] } }, "/marketplace-sellers/{id}/categories": { "get": { "tags": [ "Marketplace Seller" ], "summary": "Get the list of categories allowed for seller to update their products", "description": "This GET rest api returns list of categories for Marketplace Seller to upload their products.", "operationId": "getMarketplaceSellerCategories", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID of the store.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "languageId", "in": "query", "description": "The integer for identifying the language of the category description. To get the list of the integer mapping, please refer to the above external doc.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The seller categories were retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerCategoriesCollection" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/marketplace-sellers/{id}/online": { "patch": { "summary": "Updates the marketplace seller online status.", "description": "Updates the marketplace seller online status.", "operationId": "updateMarketplaceSellerOnlineStatus", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seller_onlinestatus_request" }, "examples": { "online": { "summary": "Marketplace Seller Administrator update seller online status", "value": { "onlineStatus": 1 } } } } }, "required": true }, "responses": { "204": { "description": "The seller online status was updated successfully.", "content": {} }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "tags": [ "Marketplace Seller" ] } }, "/marketplace-sellers/{id}/descriptions": { "get": { "tags": [ "Marketplace Seller" ], "summary": "Get the marketplace seller descriptions.", "description": "Get the marketplace seller descriptions.", "operationId": "getMarketplaceSellerDescriptions", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer(s) for identifying the language of the Marketplace seller descriptions. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The seller descriptions were retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerDescriptionCollection" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "post": { "tags": [ "Marketplace Seller" ], "summary": "Create a marketplace seller description for a language.", "description": "Create a marketplace seller description for a language.", "operationId": "createMarketplaceSellerDescription", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Marketplace Seller descriptions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerDescription_create_request" } } }, "required": true }, "responses": { "201": { "description": "The seller description is created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerDescription_response" } } }, "headers": { "Location": { "description": "The URI of the seller description.", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/marketplace-sellers/{id}/descriptions/{languageId}": { "patch": { "tags": [ "Marketplace Seller" ], "summary": "Update the description of a marketplace seller.", "operationId": "updateMarketplaceSellerDescription", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the marketplace seller.", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "path", "description": "The integer for identifying the language of the marketplace seller 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" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerDescription_update_request" } } }, "required": true }, "responses": { "204": { "description": "The seller description for the specified language is updated successfully.", "content": {} }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "delete": { "tags": [ "Marketplace Seller" ], "summary": "Delete a marketplace seller description.", "description": "Delete a marketplace seller description.", "operationId": "deleteMarketplaceSellerDescription", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the marketplace seller.", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "path", "description": "The integer for identifying the language of the marketplace seller 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" } } ], "responses": { "204": { "description": "The seller attribute with specified name and store was deleted successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/marketplace-sellers/{id}/attributes": { "get": { "tags": [ "Marketplace Seller" ], "summary": "Get marketplace seller attribute details for the seller organization Id.", "description": "Get marketplace seller attribute details for the seller organization Id.", "operationId": "getMarketplaceSellerAttributes", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The seller attributes were retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerAttributeCollection" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "post": { "tags": [ "Marketplace Seller" ], "summary": "Create the marketplace seller attribute.", "description": "Create the marketplace seller attribute.", "operationId": "createMarketplaceSellerAttribute", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Marketplace Seller description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerAttribute_create_request" } } }, "required": true }, "responses": { "201": { "description": "The seller attribute is created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerAttribute_create_response" } } }, "headers": { "Location": { "description": "The URI of the seller attribute.", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/marketplace-sellers/{id}/attributes/{name}": { "get": { "tags": [ "Marketplace Seller" ], "summary": "Get a marketplace seller attribute for the store by name.", "description": "Get a marketplace seller attribute for the store by name.", "operationId": "getMarketplaceSellerAttribute", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The marketplace seller attribute name", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerAttribute" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "patch": { "tags": [ "Marketplace Seller" ], "summary": "Update a marketplace seller attribute.", "description": "Update a marketplace seller attribute.", "operationId": "updateMarketplaceSellerAttribute", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The marketplace seller organization attribute name", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Marketplace Seller description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sellerAttribute_update_request" }, "example": { "value": "true" } } }, "required": true }, "responses": { "204": { "description": "The seller attribute is updated successfully.", "content": {} }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } }, "delete": { "tags": [ "Marketplace Seller" ], "summary": "Delete a marketplace seller attribute for the store.", "description": "Delete a marketplace seller attribute for the store.", "operationId": "deleteMarketplaceSellerAttribute", "parameters": [ { "name": "id", "in": "path", "description": "The marketplace seller organization ID", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The marketplace seller organization attribute name", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The seller attribute with specified name and store was deleted successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } } }, "components": { "schemas": { "seller_response": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique numeric ID for identifying the organization." }, "storeId": { "type": "integer", "description": "The unique numeric ID of the store.", "format": "int32" }, "storeIdentifier": { "type": "string", "description": "The unique identifier of the store." }, "storeType": { "type": "string", "description": "The 3-Character code for the store type." }, "organizationName": { "type": "string", "description": "The name of the marketplace seller organization." }, "status": { "type": "integer", "description": "Status of the marketplace seller organization. Available values:
* 0 - The organization is in Deactivated state.
* 1 - The organization is in Active state.
* 2 - The organization is in Suspended state.
* 3 - The organization is in Terminated state.", "format": "int32", "enum": [ 0, 1, 2, 3 ] }, "onlineStatus": { "type": "integer", "description": "Online Status of the marketplace seller organization. Available values:
* 1 - The organization is in Online state.
* 0 - The organization is in Offline state.", "format": "int32", "enum": [ 0, 1 ] }, "lastUpdated": { "type": "string", "description": "The last updated timestamp" } } }, "seller_create_request": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique numeric ID for identifying the organization.", "format": "int64" }, "storeId": { "type": "integer", "description": "The unique numeric ID of the store.", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time", "description": "The last updated timestamp." }, "storeType": { "type": "string", "description": "The 3-Character code for the store type." }, "storeIdentifier": { "type": "string", "description": "The unique identifier of the store." }, "status": { "type": "integer", "description": "Status of the marketplace seller organization. Available values:
* 0 - The organization is in Deactivated state.
* 1 - The organization is in Active state.
* 2 - The organization is in Suspended state.
* 3 - The organization is in Terminated state.", "format": "int32", "enum": [ 0, 1, 2, 3 ] }, "onlineStatus": { "type": "integer", "description": "Online Status of the marketplace seller organization. Available values:
* 1 - The organization is in Online state.
* 0 - The organization is in Offline state.", "format": "int32", "enum": [ 0, 1 ] } } }, "seller_update_request": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status of the marketplace seller organization. Available values:
* 0 - The organization is in Deactivated state.
* 1 - The organization is in Active state.
* 2 - The organization is in Suspended state.
* 3 - The organization is in Terminated state.", "format": "int32", "enum": [ 0, 1, 2, 3 ] }, "onlineStatus": { "type": "integer", "description": "Online Status of the marketplace seller organization. Available values:
* 1 - The organization is in Online state.
* 0 - The organization is in Offline state.", "format": "int32", "enum": [ 0, 1 ] } } }, "seller_onlinestatus_request": { "type": "object", "properties": { "onlineStatus": { "type": "integer", "description": "Online Status of the marketplace seller organization. Available values:
* 1 - The organization is in Online state.
* 0 - The organization is in Offline state.", "format": "int32", "enum": [ 0, 1 ] } } }, "sellerCollection": { "type": "object", "properties": { "count": { "type": "integer" }, "items": { "type": "array", "description": "The items.", "items": { "$ref": "#/components/schemas/seller_response" } } } }, "sellerDescriptionCollection": { "type": "object", "properties": { "count": { "type": "integer" }, "items": { "type": "array", "description": "Seller description collection.", "items": { "$ref": "#/components/schemas/sellerDescription" } } } }, "sellerDescription": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique numeric ID for identifying the organization.", "example": "7000000000000007001" }, "displayName": { "type": "string", "description": "The translated name of the marketplace seller." }, "description": { "type": "string", "description": "The translated short description of the marketplace seller." }, "languageId": { "type": "integer", "description": "The unique ID for identifying the language for the marketplace seller description.", "format": "int32" } } }, "sellerDescription_response": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique numeric ID for identifying the organization.", "format": "int32" }, "displayName": { "type": "string", "description": "The translated name of the marketplace seller." }, "description": { "type": "string", "description": "The translated short description of the marketplace seller." }, "languageId": { "type": "integer", "description": "The unique ID for identifying the language for the marketplace seller description.", "format": "int32" } } }, "sellerDescription_create_request": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The translated name of the marketplace seller." }, "description": { "type": "string", "description": "The translated short description of the marketplace seller." }, "languageId": { "type": "integer", "description": "The unique ID for identifying the language for the marketplace seller description.", "format": "int32" } } }, "sellerDescription_update_request": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The translated name of the marketplace seller." }, "description": { "type": "string", "description": "The translated short description of the marketplace seller." } } }, "sellerAttributeCollection": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/sellerAttribute" } } }, "description": "A collection of Marketplace Seller attributes." }, "sellerAttribute_create_request": { "type": "object", "properties": { "storeId": { "type": "integer", "description": "The unique numeric ID of the store where the attribute applies. This parameter can only be set at attribute creation time.", "format": "int32" }, "name": { "type": "string", "description": "The marketplace seller attribute name." }, "value": { "type": "string", "description": "The marketplace seller attribute value." } }, "description": "Marketplace Seller attribute." }, "sellerAttribute_update_request": { "type": "object", "properties": { "value": { "type": "string", "description": "The marketplace seller attribute value." } }, "description": "Marketplace Seller attribute." }, "sellerAttribute_create_response": { "type": "object", "properties": { "id": { "type": "integer", "description": "The marketplace Seller organization Id", "format": "int64" }, "storeId": { "type": "integer", "description": "The unique numeric ID of the store where the attribute applies. This parameter can only be set at attribute creation time.", "format": "int32" }, "name": { "type": "string", "description": "The marketplace seller attribute name." } }, "description": "Marketplace Seller attribute." }, "sellerAttribute": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique numeric ID for identifying the organization.", "example": "7000000000000007001" }, "storeId": { "type": "integer", "description": "The unique numeric ID of the store where the attribute applies. This parameter can only be set at attribute creation time.", "format": "int32" }, "name": { "type": "string", "description": "The marketplace seller attribute name." }, "value": { "type": "string", "description": "The marketplace seller attribute value." } }, "description": "Marketplace Seller attribute." }, "sellerCategoriesCollection": { "type": "object", "properties": { "count": { "type": "integer" }, "items": { "type": "array", "description": "Seller Categories collection.", "items": { "$ref": "#/components/schemas/sellerCategories" } } } }, "sellerCategories": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the category." }, "identifier": { "type": "string", "description": "The identifier of category." }, "languageId": { "type": "integer", "description": "The language ID of the category description." }, "name": { "type": "string", "description": "The name of category." }, "shortDescription": { "type": "string", "description": "The short description of category." } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "Marketplace Seller", "description": "Marketplace seller details and status." } ], "externalDocs": { "description": "Some REST services take languageId as a request parameter. For a list of the integers that map to the supported default languages, please refer to this Help Center page.", "url": "https://help.hcltechsw.com/commerce/9.1.0/database/database/language.html" } }