{ "openapi": "3.0.1", "info": { "title": "Installment Rule", "description": "Create and administer the installment rule", "version": "9.1.20.0", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/rest/admin/v2", "variables": { "port": { "default": "443", "enum": [ "443", "8000" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "tags": [ { "name": "Installment Rule", "description": "Provide RESTful services to manage installment rule resources." } ], "paths": { "/installment-rules": { "get": { "tags": [ "Installment Rule" ], "summary": "Get all the installment rule under a particular store.", "parameters": [ { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32", "x-context-data": "storeId" }, "x-context-data": "storeId" }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } }, { "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": "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" } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCollection" } } }, "x-entity-path": "dataArea/installmentRule" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_Summary" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create an installment rule.", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRule" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID", "links": { "GetInstallmentRuleByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}/get", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId" }, "description": "The `id`,`storeId`value used in the request body can be used as the `id`,`storeId` parameter in `GET /installment-rules/{id}`.\n" }, "DeleteInstallmentRuleByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}/delete", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id` `storeId ` value used in the request body can be used as the `id` ,'storeId ' parameter in `DELETE /installment-rules/{id}`.\n" }, "ActivateInstallmentRule": { "operationRef": "#/paths/~1/installment-rules/{id}/activate/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `POST /installment-rules/{id}/activate`.\n" }, "CreateCatalogEntryAssociationIdforInstallRule": { "operationRef": "#/paths/~1/installment-rules~1{id}~1catalog-entry-associations/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `Post /installment-rules/{id}/catalog-entry-associations`.\n" }, "CreateCatalogGroupAssociationIdforInstallRule": { "operationRef": "#/paths/~1installment-rules~1{id}~1catalog-group-associations/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `POST /installment-rules/{id}/catalog-group-associations`.\n" }, "CreateConditionIdforInstallRule": { "operationRef": "#/paths/~1installment-rules~1{id}~1conditions/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `POST /installment-rules/{id}/conditions`.\n" }, "CreateInsallRuleoptions": { "operationRef": "#/paths/~1installment-rules~1{id}/options/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `POST /installment-rules/{id}/options`.\n" }, "CreatePaymentMethodAssociations": { "operationRef": "#/paths/~1installment-rules~!{id}~1payment-method-associations/post", "parameters": { "id": "$response.header.Location", "storeId": "$request.body#/storeId " }, "description": "The `id`,`storeId `value used in the request body can be used as the `id`,`storeId` parameter in `POST /installment-rules/{id}/payment-method-associations`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "processInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/by-name-or-description": { "get": { "tags": [ "Installment Rule" ], "summary": "Get installment rules by name or description.", "parameters": [ { "name": "storeId", "in": "query", "description": "The unique numeric ID for identifying the store.", "required": true, "schema": { "type": "integer", "format": "int32", "x-context-data": "storeId" }, "x-context-data": "storeId" }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "The text used to search the rule names and descritpions.", "required": true, "schema": { "type": "string" } }, { "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": "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" } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCollection" } } }, "x-entity-path": "dataArea/installmentRule" } }, "x-expression-builder-class": "com.ibm.commerce.foundation.internal.client.taglib.util.SearchExpressionBuilder", "x-expression-builder-method": "formatExpression", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_Summary", "template": "/InstallmentRule[search(InstallmentRuleIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')]" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" } }, "/installment-rules/{id}": { "get": { "tags": [ "Installment Rule" ], "summary": "Get an installment rule by using the installment rule ID.", "operationId": "getInstallmentRuleByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRule" } } }, "x-entity-path": "dataArea/installmentRule[1]" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "delete": { "tags": [ "Installment Rule" ], "summary": "Delete an installment rule.", "operationId": "deleteInstallmentRuleByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "processInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Update an installment rule.", "operationId": "updateInstallmentRuleByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRule" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/activate": { "post": { "tags": [ "Installment Rule" ], "summary": "Activate an installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "TThe unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Activate", "x-expression-template": "/InstallmentRule[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "processInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType" } }, "/installment-rules/{id}/catalog-entry-associations": { "get": { "tags": [ "Installment Rule" ], "summary": "Get the collection of catalog entry associations by using the installment rule ID.", "operationId": "getCataloEntryAssociationsByInstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogEntryAssociationCollection" } } }, "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create a catalog entry association for the installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogEntryAssociation" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the catalog entry association of the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation[1]/installmentRuleCatalogEntryAssociationIdentifier/uniqueID", "links": { "GetCataloEntryAssociationsByInstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1catalog-entry-associations/get", "parameters": { "id": "$request.body#/id", "storeId ": "$request.body#/storeId " }, "description": "The `id`& `storeId` value used in the request body can be used as the `id`& `storeId` parameter in `GET /installment-rules/{id}/catalog-entry-associations`.\n" }, "DeleteCataloEntryAssociationsByInstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1catalog-entry-associations/delete", "parameters": { "id": "$request.body#/id", "catalogEntryAssociationId ": "$request.body#/catalogEntryAssociationId ", "storeId ": "$request.body#/storeId " }, "description": "The `id`, `catalogEntryAssociationId`,`storeId` value used in the request body can be used as the `id`,`catalogEntryAssociationId`,`storeId` parameter in `DELETE /installment-rules/{id}/catalog-entry-associations/{catalogEntryAssociationId}`.\n" }, "UpdateCataloEntryAssociationsByInstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1catalog-entry-associations/patch", "parameters": { "id": "$request.body#/id", "catalogEntryAssociationId ": "$request.body#/catalogEntryAssociationId ", "storeId ": "$request.body#/storeId " }, "description": "The `id`,`catalogEntryAssociationId`,`storeId` value used in the request body can be used as the `id`, `catalogEntryAssociationId`,`storeId` parameter in `PATCH /installment-rules/{id}/catalog-entry-associations/{catalogEntryAssociationId}`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]/CatalogEntryAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/catalog-entry-associations/{catalogEntryAssociationId}": { "delete": { "tags": [ "Installment Rule" ], "summary": "Delete a catalog entry association for the installment rule.", "operationId": "deleteCataloEntryAssociationsByInstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "catalogEntryAssociationId", "in": "path", "description": "The unique numeric ID for identifying the catalog entry that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation[1]/installmentRuleCatalogEntryAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation[1]/installmentRuleCatalogEntryAssociationIdentifier/uniqueID" } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]/CatalogEntryAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Change the catalog entry association.", "operationId": "updateCataloEntryAssociationsByInstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "catalogEntryAssociationId", "in": "path", "description": "The unique numeric ID for identifying the catalog entry that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation[1]/installmentRuleCatalogEntryAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/catalogEntryAssociation[1]/installmentRuleCatalogEntryAssociationIdentifier/uniqueID" } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogEntryAssociation" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]/CatalogEntryAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/catalog-group-associations": { "get": { "tags": [ "Installment Rule" ], "summary": "Get the collection of category associations by using the installment rule ID.", "operationId": "getCategoryGroupAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogGroupAssociationCollection" } } }, "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create a category association for the installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogGroupAssociation" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the category that is associated with the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation[1]/installmentRuleCatalogGroupAssociationIdentifier/uniqueID", "links": { "GetCategoryGroupAssociationsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1catalog-group-associations/get", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId" }, "description": "The `id`&`storeId` value used in the request body can be used as the `id` ,`storeId` parameter in `GET /installment-rules/{id}/catalog-group-associations`.\n" }, "DeleteCategoryGroupAssociationsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1catalog-group-associations~1{catalogGroupAssociationId}/delete", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "catalogGroupAssociationId": "$request.body#/catalogGroupId " }, "description": "The `id`,`catalogGroupAssociationId`, `storeId` value used in the request body can be used as the `id`,`catalogGroupAssociationId`,`storeId` parameter in `DELETE /installment-rules/{id}/catalog-group-associations/{catalogGroupAssociationId}`.\n" }, "UpdateCategoryGroupAssociationsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1catalog-group-associations~1{catalogGroupAssociationId}/patch", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "catalogGroupAssociationId": "$request.body#/catalogGroupId " }, "description": "The `id`,`catalogGroupAssociationId`,`storeId` value used in the request body can be used as the `id`,`catalogGroupAssociationId`,`storeId` parameter in `PATCH /installment-rules/{id}/catalog-group-associations/{catalogGroupAssociationId}`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]/CatalogGroupAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/catalog-group-associations/{catalogGroupAssociationId}": { "delete": { "tags": [ "Installment Rule" ], "summary": "Delete a category association for the installment rule.", "operationId": "deleteCategoryGroupAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "catalogGroupAssociationId", "in": "path", "description": "The unique numeric ID for identifying the category that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation[1]/installmentRuleCatalogGroupAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation[1]/installmentRuleCatalogGroupAssociationIdentifier/uniqueID" } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]/CatalogGroupAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Change the category association.", "operationId": "updateCategoryGroupAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "catalogGroupAssociationId", "in": "path", "description": "The unique numeric ID for identifying the category that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation[1]/installmentRuleCatalogGroupAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/catalogGroupAssociation[1]/installmentRuleCatalogGroupAssociationIdentifier/uniqueID" } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCatalogGroupAssociation" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]/CatalogGroupAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/conditions": { "get": { "tags": [ "Installment Rule" ], "summary": "Get the collection of conditions by installment rule ID.", "operationId": "getCollectionOfCondtionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleConditionCollection" } } }, "x-entity-path": "dataArea/installmentRule[1]/condition" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create a condition for the installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCondition" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the condition of the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/condition[1]/installmentRuleConditionIdentifier/uniqueID", "links": { "GetCollectionOfCondtionsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1conditions/get", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId" }, "description": "The `id`,`storeId` value used in the request body can be used as the `id` &`storeId` parameter in `GET /installment-rules/{id}/conditions`.\n" }, "DeletetCollectionOfCondtionsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1conditions~1{conditionId}/delete", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "conditionId": "$request.body#/id" }, "description": "The `id`,`conditionId`,`storeId` value used in the request body can be used as the `id`,`conditionId`,`storeId` parameter in `DELETE /installment-rules/{id}/conditions/{conditionId}`.\n" }, "UpdatetCollectionOfCondtionsByinstallId": { "operationRef": "#/paths~1installment-rules~1{id}~1conditions~1{conditionId}/patch", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "conditionId": "$request.body#/id" }, "description": "The `id`,`conditionId`,`storeId` value used in the request body can be used as the `id`,`conditionId`,`storeId` parameter in `PATCH /installment-rules/{id}/conditions/{conditionId}`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]/Condition[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/conditions/{conditionId}": { "delete": { "tags": [ "Installment Rule" ], "summary": "Delete a condition for the installment rule.", "operationId": "deletetCollectionOfCondtionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "conditionId", "in": "path", "description": "The unique numeric ID for identifying the condition that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/condition[1]/installmentRuleConditionIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/condition[1]/installmentRuleConditionIdentifier/uniqueID" } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]/Condition[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Change the condition.", "operationId": "updatetCollectionOfCondtionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "conditionId", "in": "path", "description": "The unique numeric ID for identifying the condition that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/condition[1]/installmentRuleConditionIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/condition[1]/installmentRuleConditionIdentifier/uniqueID" } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleCondition" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]/Condition[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/deactivate": { "post": { "tags": [ "Installment Rule" ], "summary": "Deactivate an installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Deactivate", "x-expression-template": "/InstallmentRule[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "processInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ProcessInstallmentRuleType" } }, "/installment-rules/{id}/options": { "get": { "tags": [ "Installment Rule" ], "summary": "Get the collection of installment options by installment rule ID.", "operationId": "getCollectinoptionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleInstallmentOptionCollection" } } }, "x-entity-path": "dataArea/installmentRule[1]/installmentOption" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create an intallment option for the installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleInstallmentOption" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the installment option of the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/installmentOption[1]/installmentOptionIdentifier/uniqueID", "links": { "GetCollectinoptionsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1options/get", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId" }, "description": "The `id`,`storeId` value used in the request body can be used as the `id`,`storeId` parameter in `GET /installment-rules/{id}/options`.\n" }, "DeleteCollectinoptionsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1options:{installmentOptionId}/delete", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "installmentOptionId": "$request.body#/id" }, "description": "The `id`,`installmentOptionId`,`storeId` value used in the request body can be used as the `id`,`installmentOptionId`,`storeId` parameter in `DELETE /installment-rules/{id}/options/{installmentOptionId}`.\n" }, "UpdateCollectinoptionsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1options:{installmentOptionId}/patch", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "installmentOptionId": "$request.body#/id" }, "description": "The `id` & `installmentOptionId`,`storeId` value used in the request body can be used as the `id` & `installmentOptionId`,`storeId` parameter in `PATCH /installment-rules/{id}/options/{installmentOptionId}`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]/InstallmentOption[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/options/{installmentOptionId}": { "delete": { "tags": [ "Installment Rule" ], "summary": "Delete an installment option for the installment rule.", "operationId": "deleteCollectinoptionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "installmentOptionId", "in": "path", "description": "The unique numeric ID for identifying the installment option of the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentOption[1]/installmentOptionIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentOption[1]/installmentOptionIdentifier/uniqueID" } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]/InstallmentOption[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Change the installment option.", "operationId": "updateCollectinoptionsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "installmentOptionId", "in": "path", "description": "The unique numeric ID for identifying the installment option of the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentOption[1]/installmentOptionIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentOption[1]/installmentOptionIdentifier/uniqueID" } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRuleInstallmentOption" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]/InstallmentOption[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/payment-method-associations": { "get": { "tags": [ "Installment Rule" ], "summary": "Get the collection of payment method associations by installment rule ID.", "operationId": "getPaymentmethodAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "dataLanguageIds", "in": "query", "description": "The integer ID for identifying the data language. For a list of integer language identifiers, refer to the Knowledge Center.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The operation is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRulePaymentMethodAssociationCollection" } } }, "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation" } }, "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/InstallmentRule[InstallmentRuleIdentifier[(UniqueID='{id}')]]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "getInstallmentRule", "x-parameters": { "accessProfile": "IBM_Admin_All" }, "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.GetInstallmentRuleType" }, "post": { "tags": [ "Installment Rule" ], "summary": "Create a payment method association for the installment rule.", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRulePaymentMethodAssociation" } } }, "required": true }, "responses": { "201": { "description": "The operation is successful.", "headers": { "Location": { "description": "The URI of the payment method association of the installment rule.", "schema": { "type": "string" } } }, "content": {}, "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation[1]/installmentRulePaymentMethodAssociationIdentifier/uniqueID", "links": { "GetPaymentmethodAssociationsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1payment-method-associations/get", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId" }, "description": "The `id`,`storeId`value used in the request body can be used as the `id`,`storeId` parameter in `GET /installment-rules/{id}/payment-method-associations`.\n" }, "DeletePaymentmethodAssociationsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1payment-method-associations~1{paymentMethodId}/delete", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "paymentMethodId ": "$request.body#/paymentMethodId " }, "description": "The `id`,`paymentMethodId`,`storeId` value used in the request body can be used as the `id`,`paymentMethodId`,`storeId` parameter in `DELETE /installment-rules/{id}/payment-method-associations/{paymentMethodId}`.\n" }, "UpdatePaymentmethodAssociationsByinstallId": { "operationRef": "#/paths/~1installment-rules~1{id}~1payment-method-associations~1{paymentMethodId}/patch", "parameters": { "id ": "$request.path.id", "storeId": "$request.query.storeId", "paymentMethodId ": "$request.body#/paymentMethodId " }, "description": "The `id`,`paymentMethodId`,`storeId` value used in the request body can be used as the `id`,`paymentMethodId`,`storeId` parameter in `PATCH /installment-rules/{id}/payment-method-associations/{paymentMethodId}`.\n" } } } }, "x-action-code": "Add", "x-expression-template": "/InstallmentRule[1]/PaymentMethodAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond", "x-codegen-request-body-name": "body" } }, "/installment-rules/{id}/payment-method-associations/{paymentMethodId}": { "delete": { "tags": [ "Installment Rule" ], "summary": "Delete a payment method association for the installment rule.", "operationId": "deletePaymentmethodAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "paymentMethodId", "in": "path", "description": "The unique numeric ID for identifying the payment method association that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation[1]/installmentRulePaymentMethodAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation[1]/installmentRulePaymentMethodAssociationIdentifier/uniqueID" } ], "responses": { "204": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Delete", "x-expression-template": "/InstallmentRule[1]/PaymentMethodAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-request-verb": "change", "x-response-verb": "respond" }, "patch": { "tags": [ "Installment Rule" ], "summary": "Change the payment method assoication.", "operationId": "updatePaymentmethodAssociationsByinstallId", "parameters": [ { "name": "id", "in": "path", "description": "The unique numeric ID for identifying the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/installmentRuleIdentifier/uniqueID" }, { "name": "storeId", "in": "query", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "paymentMethodId", "in": "path", "description": "The unique numeric ID for identifying the payment method association that is associated with the installment rule.", "required": true, "schema": { "type": "integer", "format": "int64", "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation[1]/installmentRulePaymentMethodAssociationIdentifier/uniqueID" }, "x-entity-path": "dataArea/installmentRule[1]/paymentMethodAssociation[1]/installmentRulePaymentMethodAssociationIdentifier/uniqueID" } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstallmentRulePaymentMethodAssociation" } } }, "required": true }, "responses": { "200": { "description": "The operation is successful.", "content": {} } }, "x-action-code": "Change", "x-expression-template": "/InstallmentRule[1]/PaymentMethodAssociation[1]", "x-facade-client-class": "com.ibm.commerce.installment.facade.client.InstallmentFacadeClient", "x-facade-client-method": "changeInstallmentRule", "x-request-bod-class": "com.ibm.commerce.installment.facade.datatypes.ChangeInstallmentRuleType", "x-codegen-request-body-name": "body" } } }, "components": { "schemas": { "InstallmentRule": { "type": "object", "properties": { "catalog-entry-associations": { "type": "array", "description": "The collection of catalog entry associations.", "items": { "$ref": "#/components/schemas/InstallmentRuleCatalogEntryAssociation" }, "x-entity-path": "catalogEntryAssociation" }, "catalog-group-associations": { "type": "array", "description": "The collection of category associations.", "items": { "$ref": "#/components/schemas/InstallmentRuleCatalogGroupAssociation" }, "x-entity-path": "catalogGroupAssociation" }, "conditions": { "type": "array", "description": "The collection of installment rule conditions.", "items": { "$ref": "#/components/schemas/InstallmentRuleCondition" }, "x-entity-path": "condition" }, "description": { "type": "string", "description": "The administrative description of the installment rule." }, "endDateTime": { "type": "string", "description": "The end date and time of this rule.", "format": "date-time" }, "id": { "type": "integer", "description": "The unique numeric ID for identifying the installment rule.", "format": "int64", "readOnly": true, "x-entity-path": "installmentRuleIdentifier/uniqueID" }, "name": { "type": "string", "description": "The name of the installment rule.", "x-entity-path": "installmentRuleIdentifier/externalIdentifier/name" }, "options": { "type": "array", "description": "The collection of installment options.", "items": { "$ref": "#/components/schemas/InstallmentRuleInstallmentOption" }, "x-entity-path": "installmentOption" }, "payment-method-associations": { "type": "array", "description": "The collection of payment method associations.", "items": { "$ref": "#/components/schemas/InstallmentRulePaymentMethodAssociation" }, "x-entity-path": "paymentMethodAssociation" }, "priority": { "type": "number", "description": "The priority of the rule. A larger value represents a higher priority.", "format": "double" }, "startDateTime": { "type": "string", "description": "Start date and time of this rule.", "format": "date-time" }, "status": { "type": "string", "description": "The status of the rule. This value can only be changed by the activate/deactivate APIs.", "readOnly": true }, "storeId": { "type": "integer", "description": "The unique numeric ID for identifying the store.", "format": "int32", "x-entity-path": "installmentRuleIdentifier/externalIdentifier/storeIdentifier/uniqueID" }, "updatedDateTime": { "type": "string", "description": "The date and time at which this rule was updated. This value cannot be edited.", "format": "date-time", "readOnly": true, "x-entity-path": "lastUpdateDateTime" } }, "description": "An installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentRuleType" }, "InstallmentRuleCatalogEntryAssociation": { "type": "object", "properties": { "associationType": { "type": "string", "description": "The catalog entry association type, either \"Inclusion\" or \"Exclusion\"." }, "catalogEntryId": { "type": "integer", "description": "The unique numeric ID of the catalog entry that is associated with the installment rule.", "format": "int64", "x-entity-path": "catalogEntryIdentifier/uniqueID" }, "id": { "type": "integer", "description": "The unique numeric ID for identifying the catalog entry association.", "format": "int64", "x-entity-path": "installmentRuleCatalogEntryAssociationIdentifier/uniqueID" } }, "description": "The catalog entry association of an installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentRuleCatalogEntryAssociationType" }, "InstallmentRuleCatalogEntryAssociationCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRuleCatalogEntryAssociation" } } }, "description": "A collection of catalog entry associations of an installment rule." }, "InstallmentRuleCatalogGroupAssociation": { "type": "object", "properties": { "associationType": { "type": "string", "description": "The category association type, either \"Inclusion\" or \"Exclusion\"." }, "catalogGroupId": { "type": "integer", "description": "The unique numeric ID of the category that is associated with the installment rule.", "format": "int64", "x-entity-path": "catalogGroupIdentifier/uniqueID" }, "id": { "type": "integer", "description": "The unique numeric ID for identifying the installment rule.", "format": "int64", "readOnly": true, "x-entity-path": "installmentRuleCatalogGroupAssociationIdentifier/uniqueID" } }, "description": "The category association of an installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentRuleCatalogGroupAssociationType" }, "InstallmentRuleCatalogGroupAssociationCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRuleCatalogGroupAssociation" } } }, "description": "A collection of category associations of an installment rule." }, "InstallmentRuleCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRule" } }, "limit": { "type": "integer", "description": "The maximum number of records to return.", "format": "int32" }, "offset": { "type": "integer", "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.", "format": "int32" } }, "description": "A collection of installment rules." }, "InstallmentRuleCondition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The condition type" }, "id": { "type": "integer", "description": "The unique numeric ID for identifying the condition.", "format": "int64", "x-entity-path": "installmentRuleConditionIdentifier/uniqueID" }, "userData": { "type": "object", "additionalProperties": { "type": "string" }, "x-entity-path": "userData/userDataField" } }, "description": "The condition of an installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentRuleConditionType" }, "InstallmentRuleConditionCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRuleCondition" } } }, "description": "A collection of conditions of an installment rule." }, "InstallmentRuleInstallmentOption": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique numeric ID for identifying the installment option.", "format": "int64", "readOnly": true, "x-entity-path": "installmentOptionIdentifier/uniqueID" }, "interestRate": { "type": "number", "description": "The interest rate of the installment rule.", "x-entity-path": "interestRate" }, "minimumInstallmentAmount": { "$ref": "#/components/schemas/MonetaryAmount" }, "numberOfInstallments": { "type": "integer", "description": "The number of installments required for the installment rule.", "format": "int32", "x-entity-path": "numberOfInstallments" } }, "description": "The installment option of an installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentOptionType" }, "InstallmentRuleInstallmentOptionCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRuleInstallmentOption" } } }, "description": "A collection of installment options of an installment rule." }, "InstallmentRulePaymentMethodAssociation": { "type": "object", "properties": { "associationType": { "type": "string", "description": "The payment method association type, either \"Inclusion\" or \"Exclusion\"." }, "id": { "type": "integer", "description": "The unique numeric ID for identifying the payment method association that is associated with the installment rule.", "format": "int64", "readOnly": true, "x-entity-path": "installmentRulePaymentMethodAssociationIdentifier/uniqueID" }, "name": { "type": "string", "description": "The name of the payment method for the installment rule.", "x-entity-path": "paymentMethodName" } }, "description": "The payment method association of an installment rule.", "x-entity-class": "com.ibm.commerce.installment.facade.datatypes.InstallmentRulePaymentMethodAssociationType" }, "InstallmentRulePaymentMethodAssociationCollection": { "type": "object", "properties": { "count": { "type": "integer", "description": "The total number of item records that match the query parameters.", "format": "int64" }, "items": { "type": "array", "description": "The data objects or resources that that match the query parameters.", "items": { "$ref": "#/components/schemas/InstallmentRulePaymentMethodAssociation" } } }, "description": "A collection of payment method associations of an installment rule." }, "MonetaryAmount": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the monetary amount.", "x-entity-path": "currency" }, "value": { "type": "number", "description": "The value of the monetary amount.", "format": "double", "x-entity-path": "value" } }, "description": "The monetary value of the constant entry.", "x-entity-class": "com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType" } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "x-components": {} }