{ "openapi": "3.0.0", "info": { "description": "## Basics\n\nThe CPQ API follows a microservice architecture that enables CPQ into any part of an application and is built on the [JSON API](https://jsonapi.org/ \"https://jsonapi.org/\") specification, follows predictable [REST](https://en.wikipedia.org/wiki/Representational_state_transfer \"https://en.wikipedia.org/wiki/Representational_state_transfer\") URLs and supports [cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing \"https://en.wikipedia.org/wiki/Cross-origin_resource_sharing\").\n\n## Authentication\n\nAll requests to the API need to be accompanied by an authorization header with a standard salesforce authentication token\n\n Authorization: Bearer 00D230000000nZM!ARMAQHLLm33JxYYP.UJn1gF6FFmLv8sDYK_8szeckHWtbguztoBpF0HL8...\n\nIf you are calling ABO APIs as part of a Digital Commerce flow, refer to the [Conga Digital Commerce API documentation](https://documentation.conga.com/cdcwin20/winter-20-rest-api-guide/cpq-rest-api-version-2) for obtaining the authentication token. Otherwise, use any standard Salesforce [approach](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&type=5 \"https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&type=5\") for obtaining a custom access token for use with the API.\n\n## Endpoint\n\nThe CPQ API is installed with the CPQ managed package and can be exposed to external applications through a Salesforce site or community. After a community or site is built, all APIs will have the following structure\n\n https://mycommunity.force.com/community/services/apexrest/apttus/:version/:api`\n\n\n## Versions\n\nThe CPQ API ensures backward compatibility by properly versioning any changes to the APIs. When a change to the API structure is required, it will occur within a new version and older functionality will be preserved.\n\n## X-Storefront Header Parameter\n\nIn order to match your API requests with a storefront, the x-storefront parameter must be used with all requests in the request header. It should match a storefront name record in SFDC.\n\n x-storefront: my-storefront`\n\n\n## Content Type\n\nRequests made to the API must be encoded as **JSON** and contain the header\n\n Content-Type: application/json\n\n## Includes\n\nYou can easily include resource relationships on most top-level resources. Multiple includes are defined using comma delimited values.\n\n## Caching\n\nServer-side caching is used and can be configured based on request using the cacheStrategy query parameter.\n\n## Errors\n\nAny request that returns an error follows a standard format. The CPQ API will return an array of errors that contain objects containing the status, title and data with the error details.\n\n|**Code**|**Response**|\n|--|--|\n| 201 | Created Successfully |\n| 200 | Updated Successfully |\n| 204 | Deleted Successfully |\n| 400 | Invalid JSON |\n| 422 | Validation Error |\n| 500 | Something went wrong on our end |", "contact": {}, "version": "2.0" }, "servers": [ { "url": "/" } ], "security": [ { "httpBasic": [] } ], "tags": [ { "name": "Assets" } ], "paths": { "/services/apexrest/Apttus_WebStore/apttus/v1/assets/swap": { "post": { "tags": [ "Assets" ], "summary": "Swap Assets", "operationId": "Swap", "description": "Invoke this API for swapping Assets.", "parameters": [ { "name": "x-storefront", "in": "header", "description": "The name of the storefront being used for the request.", "required": true, "style": "simple", "schema": { "type": "string", "example": "ECommerce" } }, { "name": "Authorization", "in": "header", "description": "Authentication token", "required": true, "style": "simple", "schema": { "type": "string", "example": "00DG0000000iqtB!ARUAQHofFrVurFKWS8TcFKmhFM1yiA1VBzEVVAOXDB.5r_rlpxXuj53RnqfY2QKUgsL3N.ge5kmSPN5UcHK9iHckog6eTw.4" } }, { "name": "Content-Type", "in": "header", "description": "Content type of the request body.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NewStartDate": { "type": "string" }, "ProductIds": { "type": "array", "items": { "type": "string" } }, "AssetIds": { "type": "array", "items": { "type": "string" } }, "CartIds": { "type": "string" } } }, "example": { "CartIds": "a1IW0000001ZeAVMA0", "NewStartDate": "2020-01-15", "assetIds": [ "a1IW0000001ZeAVMA0" ], "ProductIds": [ "01t19000005GatQAAS" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwapAsset" }, "example": { "title": "success", "status": 200, "data": { "a13W0000004DnOAIA0": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DnOAIA0" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001ZkCuMAK", "Apttus_Config2__BaseProductId__c": null, "Apttus_Config2__HasBaseProduct__c": false, "Apttus_Config2__LocationId__c": null, "Apttus_Config2__Uom__c": "Each", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__Term__c": 1, "Apttus_Config2__SellingTerm__c": 1, "Apttus_Config2__ProductId__c": "01tW0000003v0zdIAA", "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__LineNumber__c": 2, "Apttus_Config2__LineSequence__c": 2, "Apttus_Config2__PrimaryLineNumber__c": 2, "Apttus_Config2__ItemSequence__c": 1, "Apttus_Config2__OptionSequence__c": 0, "Apttus_Config2__IsQuantityModifiable__c": true, "Apttus_Config2__IsPrimaryLine__c": true, "Apttus_Config2__ProductVersion__c": 1, "Apttus_Config2__Comments__c": null, "Apttus_Config2__AdjustmentAmount__c": null, "Apttus_Config2__AdjustmentType__c": null, "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00WIAS", "Apttus_Config2__Description__c": "Sconto Su Misura Gas", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__AddedByRuleInfo__c": null, "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__ClassificationId__c": "a0hW0000001LNnEIAW", "Apttus_Config2__ClassificationHierarchy__c": "Oil and Gas", "Apttus_Config2__ClassificationHierarchyInfo__c": "Oil and Gas:Id=a0hW0000001LNnEIAW | Oil and Gas:IncludeInTotalsView__c=true", "Apttus_Config2__AllowManualAdjustment__c": true, "Apttus_Config2__HasAttributes__c": false, "Apttus_Config2__HasDefaults__c": false, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__LineStatus__c": "Upgraded", "Apttus_Config2__StartDate__c": "2020-09-10", "Apttus_Config2__EndDate__c": "2020-12-31", "Id": "a13W0000004DnOAIA0" }, "a0eW0000003O00YIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DnO9IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001ZkCuMAK", "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00YIAS", "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 0, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 0, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 0, "Apttus_Config2__ChargeType__c": "Usage Fee", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__EndDate__c": "2020-09-09", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 0, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsPrimaryLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ItemSequence__c": 3, "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__ListPrice__c": 0, "Apttus_Config2__NetPrice__c": 0, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__PriceListItemId__c": "a16W0000000t1rCIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Usage", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__SellingTerm__c": 8.3, "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__Term__c": 1, "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 0, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 0, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__AttributeValueId__c": "a1FW00000029d25MAA", "Id": "a13W0000004DnO9IAK", "Apttus_Config2__ContractNumbers__c": "2020-09-09" }, "a0eW0000003O00XIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DnO8IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001ZkCuMAK", "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00XIAS", "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 0, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 0, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 0, "Apttus_Config2__ChargeType__c": "Installation Fee", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__EndDate__c": "2020-09-09", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 0, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsPrimaryLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ItemSequence__c": 2, "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__ListPrice__c": 0, "Apttus_Config2__NetPrice__c": 0, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__PriceListItemId__c": "a16W0000000t1rHIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Usage", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__SellingTerm__c": 8.3, "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__Term__c": 1, "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 0, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 0, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__AttributeValueId__c": "a1FW00000029d25MAA", "Id": "a13W0000004DnO8IAK", "Apttus_Config2__ContractNumbers__c": "2020-09-09" }, "a0eW0000003O00WIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DnO7IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001ZkCuMAK", "Apttus_Config2__BaseProductId__c": null, "Apttus_Config2__HasBaseProduct__c": false, "Apttus_Config2__LocationId__c": null, "Apttus_Config2__Uom__c": "Each", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__Term__c": 1, "Apttus_Config2__SellingTerm__c": 8.3, "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__LineSequence__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__ItemSequence__c": 1, "Apttus_Config2__OptionSequence__c": 0, "Apttus_Config2__IsQuantityModifiable__c": true, "Apttus_Config2__IsPrimaryLine__c": true, "Apttus_Config2__ProductVersion__c": 1, "Apttus_Config2__Comments__c": null, "Apttus_Config2__AdjustmentAmount__c": null, "Apttus_Config2__AdjustmentType__c": null, "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00WIAS", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__ClassificationId__c": "a0hW0000001LNnEIAW", "Apttus_Config2__ClassificationHierarchy__c": "Oil and Gas", "Apttus_Config2__ClassificationHierarchyInfo__c": "Oil and Gas:Id=a0hW0000001LNnEIAW | Oil and Gas:IncludeInTotalsView__c=true", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasDefaults__c": false, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 120, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 120, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 10, "Apttus_Config2__ChargeType__c": "Subscription Fee", "Apttus_Config2__EndDate__c": "2020-09-09", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 120, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ListPrice__c": 10, "Apttus_Config2__NetPrice__c": 120, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListItemId__c": "a16W0000000t1pLIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Recurring", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 120, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 10, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__AttributeValueId__c": "a1FW00000029d25MAA", "Id": "a13W0000004DnO7IAK", "Apttus_Config2__ContractNumbers__c": "2020-09-09" } } } } } } }, "deprecated": false } }, "/services/apexrest/Apttus_WebStore/apttus/v1/assets/terminate": { "post": { "tags": [ "Assets" ], "summary": "Terminate Assets", "operationId": "TerminateAsset", "description": "Invoke this API for asset cancellation.", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authentication token", "required": true, "style": "simple", "schema": { "type": "string", "example": "00DG0000000iqtB!ARUAQHofFrVurFKWS8TcFKmhFM1yiA1VBzEVVAOXDB.5r_rlpxXuj53RnqfY2QKUgsL3N.ge5kmSPN5UcHK9iHckog6eTw.4" } }, { "name": "x-storefront", "in": "header", "description": "The name of the storefront being used for the request.", "required": true, "style": "simple", "schema": { "type": "string", "example": "ECommerce" } }, { "name": "Content-Type", "in": "header", "description": "Content type of the request body.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CancelDate": { "type": "string" }, "AssetIds": { "type": "array", "items": { "type": "string" } }, "CartIds": { "type": "string" } } }, "example": { "CancelDate": "2020-01-15", "assetIds": [ "a1IW0000001ZeAVMA0" ], "CartIds": "a1IW0000001ZeAVMA0" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateAsset" }, "example": { "title": "success", "status": 200, "data": { "a0eW0000003O00YIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DpK5IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001Zl01MAC", "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00YIAS", "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 0, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 0, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 0, "Apttus_Config2__ChargeType__c": "Usage Fee", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__EndDate__c": "2020-01-15", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 0, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsPrimaryLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ItemSequence__c": 3, "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__ListPrice__c": 0, "Apttus_Config2__NetPrice__c": 0, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__PriceListItemId__c": "a16W0000000t1rCIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Usage", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__SellingTerm__c": 0.48387, "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__Term__c": 1, "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 0, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 0, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__AttributeValueId__c": "a1FW00000029dk5MAA", "Id": "a13W0000004DpK5IAK", "Apttus_Config2__ContractNumbers__c": "2020-01-15" }, "a0eW0000003O00XIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DpK4IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001Zl01MAC", "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00XIAS", "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 0, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 0, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 0, "Apttus_Config2__ChargeType__c": "Installation Fee", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__EndDate__c": "2020-01-15", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 0, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsPrimaryLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ItemSequence__c": 2, "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__ListPrice__c": 0, "Apttus_Config2__NetPrice__c": 0, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__PriceListItemId__c": "a16W0000000t1rHIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Usage", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__SellingTerm__c": 0.48387, "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__Term__c": 1, "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 0, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 0, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__AttributeValueId__c": "a1FW00000029dk5MAA", "Id": "a13W0000004DpK4IAK", "Apttus_Config2__ContractNumbers__c": "2020-01-15" }, "a0eW0000003O00WIAS": { "attributes": { "type": "Apttus_Config2__LineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__LineItem__c/a13W0000004DpK3IAK" }, "Apttus_Config2__ConfigurationId__c": "a1IW0000001Zl01MAC", "Apttus_Config2__BaseProductId__c": null, "Apttus_Config2__HasBaseProduct__c": false, "Apttus_Config2__LocationId__c": null, "Apttus_Config2__Uom__c": "Each", "Apttus_Config2__Quantity__c": 1, "Apttus_Config2__Term__c": 1, "Apttus_Config2__SellingTerm__c": 0.48387, "Apttus_Config2__ProductId__c": "01tW0000003v0zYIAQ", "Apttus_Config2__PriceListId__c": "a173C000000JHnvQAG", "Apttus_Config2__LineType__c": "Product/Service", "Apttus_Config2__LineNumber__c": 1, "Apttus_Config2__LineSequence__c": 1, "Apttus_Config2__PrimaryLineNumber__c": 1, "Apttus_Config2__ItemSequence__c": 1, "Apttus_Config2__OptionSequence__c": 0, "Apttus_Config2__IsQuantityModifiable__c": true, "Apttus_Config2__IsPrimaryLine__c": true, "Apttus_Config2__ProductVersion__c": 1, "Apttus_Config2__Comments__c": null, "Apttus_Config2__AdjustmentAmount__c": null, "Apttus_Config2__AdjustmentType__c": null, "Apttus_Config2__AssetLineItemId__c": "a0eW0000003O00WIAS", "Apttus_Config2__Description__c": "Sconto Certo Gas", "Apttus_Config2__Customizable__c": false, "Apttus_Config2__PricingStatus__c": "Pending", "Apttus_Config2__ConfigStatus__c": "NA", "Apttus_Config2__ConstraintCheckStatus__c": "NA", "Apttus_Config2__ClassificationId__c": "a0hW0000001LNnEIAW", "Apttus_Config2__ClassificationHierarchy__c": "Oil and Gas", "Apttus_Config2__ClassificationHierarchyInfo__c": "Oil and Gas:Id=a0hW0000001LNnEIAW | Oil and Gas:IncludeInTotalsView__c=true", "Apttus_Config2__AllowManualAdjustment__c": false, "Apttus_Config2__HasAttributes__c": true, "Apttus_Config2__HasDefaults__c": false, "Apttus_Config2__HasOptions__c": false, "Apttus_Config2__BillingPreferenceId__r": { "attributes": { "type": "Apttus_Config2__BillingPreference__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__BillingPreference__c/a2dW0000000bgSYIAY" }, "Id": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingCycleStart__c": "Billing Day of Month", "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month" }, "Apttus_Config2__BillToAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v50.0/sobjects/Account/001W000000vdGsSIAU" }, "Id": "001W000000vdGsSIAU", "Apttus_Config2__BillingDayOfMonth__c": "1st of the Month" }, "Apttus_Config2__AssetLineItemId__r": { "attributes": { "type": "Apttus_Config2__AssetLineItem__c", "url": "/services/data/v50.0/sobjects/Apttus_Config2__AssetLineItem__c/a0eW0000003O00WIAS" }, "Id": "a0eW0000003O00WIAS", "Apttus_Config2__OriginalStartDate__c": "2020-01-01" }, "Apttus_Config2__AssetQuantity__c": 7, "Apttus_Config2__AutoRenewalTerm__c": 1, "Apttus_Config2__AdjustedPrice__c": 120, "Apttus_Config2__BaseExtendedCost__c": 0, "Apttus_Config2__BaseExtendedPrice__c": 120, "Apttus_Config2__BasePriceMethod__c": "Per Unit", "Apttus_Config2__BasePrice__c": 10, "Apttus_Config2__ChargeType__c": "Subscription Fee", "Apttus_Config2__EndDate__c": "2020-01-15", "Apttus_Config2__ExtendedCost__c": 0, "Apttus_Config2__ExtendedPrice__c": 120, "Apttus_Config2__Frequency__c": "Monthly", "Apttus_Config2__IsOptionRollupLine__c": false, "Apttus_Config2__IsUsageTierModifiable__c": false, "Apttus_Config2__ListPrice__c": 10, "Apttus_Config2__NetPrice__c": 120, "Apttus_Config2__PriceIncludedInBundle__c": false, "Apttus_Config2__PriceListItemId__c": "a16W0000000t1pLIAQ", "Apttus_Config2__PriceMethod__c": "Per Unit", "Apttus_Config2__PriceType__c": "Recurring", "Apttus_Config2__PriceUom__c": "Each", "Apttus_Config2__SellingFrequency__c": "Monthly", "Apttus_Config2__StartDate__c": "2020-01-01", "Apttus_Config2__IsPrimaryRampLine__c": true, "Apttus_Config2__TotalQuantity__c": 7, "Apttus_Config2__BillToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__BillingFrequency__c": "Monthly", "Apttus_Config2__BillingPreferenceId__c": "a2dW0000000bgSYIAY", "Apttus_Config2__BillingRule__c": "Bill In Advance", "Apttus_Config2__HideInvoiceDisplay__c": false, "Apttus_Config2__IsReadOnly__c": true, "Apttus_Config2__ShipToAccountId__c": "001W000000vdGsSIAU", "Apttus_Config2__TaxInclusive__c": false, "Apttus_Config2__Taxable__c": false, "Apttus_Config2__AutoRenew__c": false, "Apttus_Config2__AutoRenewalType__c": "Fixed", "Apttus_Config2__DeltaPrice__c": 120, "Apttus_Config2__DeltaQuantity__c": 1, "Apttus_Config2__NetUnitPrice__c": 10, "Apttus_Config2__SellingUom__c": "Each", "Tier1__c": "Imaging", "Tier2__c": "SCAN", "OEM_Manufacturer__c": "IBM", "Implementation_Partner__c": "SiX systems", "Apttus_Config2__LineStatus__c": "Cancelled", "Apttus_Config2__AllocateGroupAdjustment__c": false, "Apttus_Config2__AllowRemoval__c": true, "Apttus_Config2__AllowableAction__c": "No Adjustments", "Apttus_Config2__AttributeValueId__c": "a1FW00000029dk5MAA", "Id": "a13W0000004DpK3IAK", "Apttus_Config2__ContractNumbers__c": "2020-01-15" } } } } } } }, "deprecated": false } }, "/services/apexrest/Apttus_WebStore/apttus/v1/assets/{assetId}/change": { "post": { "tags": [ "Assets" ], "summary": "Change Asset", "operationId": "ChangeAsset", "description": "Invoke this API to change the parameters of an asset, associated configuration and related details.", "parameters": [ { "name": "assetId", "in": "path", "description": "The Id of the asset that needs to be changed", "required": true, "style": "simple", "schema": { "type": "string", "example": "a0e3I000000ERLmQAO" } }, { "name": "Authorization", "in": "header", "description": "authentication token", "required": true, "style": "simple", "schema": { "type": "string", "example": "00DG0000000iqtB!ARUAQHofFrVurFKWS8TcFKmhFM1yiA1VBzEVVAOXDB.5r_rlpxXuj53RnqfY2QKUgsL3N.ge5kmSPN5UcHK9iHckog6eTw.4" } }, { "name": "x-storefront", "in": "header", "description": "The name of the storefront being used for the request.", "required": true, "style": "simple", "schema": { "type": "string", "example": "ECommerce" } }, { "name": "Content-Type", "in": "header", "description": "Content type of the request body.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "application/json" } } ], "requestBody": { "description": "Note: Step Property in request body indicates which step to be run. Possible values CHANGE_ASSET, VALIDATE, RUN_CONSTRAINTS, REPRICE", "content": { "application/json": { "schema": { "type": "object", "properties": { "ProductAttributeValues": { "type": "array", "items": { "type": "object" } }, "Step": { "type": "string" }, "SelectedOptions": { "type": "array", "items": { "type": "string" } }, "CartId": { "type": "string" }, "CancelledOptions": { "type": "array", "items": { "type": "string" } }, "AmendedAssets": { "type": "array", "items": { "type": "string" } } } }, "example": { "ProductAttributeValues": [ { "AssetId": null, "AttributeValueExt3SO": { "attributes": { "type": "Apttus_Config2__ProductAttributeValueExt3__c" }, "TestPAVExt3Field__c": "fieldValue", "TestPAVExt3Field2__c": "fieldValue2" }, "AttributeValueExt2SO": { "attributes": { "type": "Apttus_Config2__ProductAttributeValueExt2__c" }, "TestPAVExt2Field__c": "fieldValue", "TestPAVExt2Field2__c": "fieldValue2" }, "AttributeValueExtSO": { "attributes": { "type": "Apttus_Config2__ProductAttributeValueExt__c" }, "TestPAVExtField__c": "fieldValue", "TestPAVExtField2__c": "fieldValue2" }, "AttributeValueSO": { "attributes": { "type": "Apttus_Config2__ProductAttributeValue__c" }, "Apttus_Config2__Age__c": "10", "Apttus_Config2__Vendor__c": "Vendor 1" }, "NullFields": { "Apttus_Config2__ProductAttributeValue__c": [ "Apttus_Config2__Color__c", "Field1__c" ], "Apttus_Config2__ProductAttributeValueExt__c": [ "fieldExt1__c" ], "Apttus_Config2__ProductAttributeValueExt2__c": [ "fieldExt2__c" ], "Apttus_Config2__ProductAttributeValueExt3__c": [ "fieldExt3__c" ] } } ], "Step": "CHANGE_ASSET", "SelectedOptions": [ { "StartDate": "2020-10-16", "SellingTerm": 12, "Quantity": 3, "EndDate": "2020-11-14", "CustomFields": [ "LineItem_Custom_field1__c", "LineItem_Custom_field2__c" ], "CustomData": { "attributes": { "type": "Apttus_Config2__LineItem__c" }, "LineItem_Custom_field1__c": "value1", "LineItem_Custom_field2__c": "value2" }, "ComponentProductId": "01t1I000000imxpQAA", "ComponentId": "a0z1I000005dSnrQAE", "Comments": "description", "AttributeValues": [ { "attributes": { "type": "Apttus_Config2__ProductAttributeValue__c" }, "IsBundle__c": true } ] } ], "CartId": "a0p1I000009KLLUQA4", "CancelledOptions": [ "a0p1I000009KLLUQA4" ], "AmendedAssets": [ { "attributes": { "type": "Apttus_Config2__LineItem__c" }, "Apttus_Config2__Quantity__c": 3, "LineItemCustomField__C": "value" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAsset" }, "example": { "title": "success", "status": 200, "data": { "pageErrors": null, "nextStep": "VALIDATE", "hasError": false } } } } }, "500": { "description": "Error <br> Note: For the pageErrors.pricingReponse is only applicable when the step value is REPRICE in the request body.", "content": { "application/json": { "example": { "title": "Internal Error", "status": 500, "data": { "lineNumber": 84, "cause": null, "stackTrace": "(Apttus_WebStore)\n\n\n\n", "message": "{\"pageErrors\":{\"warningMessages\":[],\"successMessages\":[],\"pricingResponse\":null,\"infoMessages\":[],\"errorMessages\":[\"Invalid card Id 01tW0000003vsKjIAI\"]},\"nextStep\":\"CHANGE_ASSET\",\"hasError\":true}" } } } } } }, "deprecated": false } } }, "components": { "schemas": { "Product": { "title": "Product", "required": [ "ConfigurationType", "Description", "HasAttributes", "HasOptions", "Icon", "Id", "IsActive", "Name", "ProductId" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Icon": { "type": "string" }, "ProductId": { "type": "string" }, "HasOptions": { "type": "boolean" }, "HasAttributes": { "type": "boolean" }, "Description": { "type": "string" }, "ConfigurationType": { "type": "string" }, "IsActive": { "type": "boolean" }, "AttributeGroups": { "type": "array", "items": { "type": "object", "properties": { "AttributeGroupId": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" } } } }, "OptionGroups": { "type": "array", "items": { "type": "object", "properties": { "ComponentProductId": { "type": "string" }, "Required": { "type": "boolean" }, "ProductOptionGroupId": { "type": "string" }, "ParentProductId": { "type": "string" }, "Modifiable": { "type": "boolean" }, "MinQuantity": { "type": "integer" }, "MaxQuantity": { "type": "integer" }, "Default": { "type": "boolean" }, "DefaultQuantity": { "type": "integer" }, "AllowCloning": { "type": "boolean" }, "Name": { "type": "string" }, "Id": { "type": "string" } } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "ProductRules": { "title": "ProductRules", "required": [ "Active", "ConstraintRuleActions", "ConstraintRuleConditions", "Id", "MatchInOptions", "MatchInPrimaryLines", "Name" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "ConstraintRuleConditions": { "type": "array", "items": { "type": "object", "properties": { "ConstraintRuleId": { "type": "string" }, "ProductId": { "type": "string" }, "ProductScope": { "type": "string" } } } }, "ConstraintRuleActions": { "type": "array", "items": { "type": "object", "properties": { "ConstraintRuleId": { "type": "string" }, "ProductId": { "type": "string" }, "ProductScope": { "type": "string" }, "ActionType": { "type": "string" }, "AutoInclude": { "type": "boolean" }, "Message": { "type": "string" } } } }, "MatchInOptions": { "type": "boolean" }, "MatchInPrimaryLines": { "type": "boolean" }, "Active": { "type": "boolean" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Categories": { "title": "Categories", "required": [ "Id", "IsHidden", "Label", "MaxOptions", "MinOptions", "Name" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Label": { "type": "string" }, "MinOptions": { "type": "integer" }, "MaxOptions": { "type": "integer" }, "IsHidden": { "type": "boolean" } }, "example": { "title": "success", "status": 200, "data": {} } }, "CartItems": { "title": "CartItems", "required": [ "LineItems", "Rules" ], "type": "object", "properties": { "Rules": { "type": "array", "items": { "type": "object", "properties": { "ActionProductIds": { "type": "string" }, "TriggeringProductIds": { "type": "string" }, "SuggestedProductIds": { "type": "string" }, "IsTargetOption": { "type": "boolean" }, "pending": { "type": "boolean" }, "ConstraintRuleActionId": { "type": "string" }, "ConfigurationId": { "type": "string" }, "Message": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" } } } }, "LineItems": { "type": "array", "items": { "type": "object", "properties": { "Product": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "AttributeValue": { "type": "object", "properties": { "Id": { "type": "string" } } }, "LineSequence": { "type": "integer" }, "LineType": { "type": "string" }, "LineStatus": { "type": "string" }, "LineNumber": { "type": "integer" }, "ItemSequence": { "type": "integer" }, "Quantity": { "type": "integer" }, "ProductId": { "type": "string" }, "PrimaryLineNumber": { "type": "integer" }, "Name": { "type": "string" }, "IsPrimaryLine": { "type": "boolean" }, "Id": { "type": "string" } } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "RemoveMultipleRecord": { "title": "RemoveMultipleRecord", "required": [ "errors", "id", "success" ], "type": "object", "properties": { "id": { "type": "string" }, "success": { "type": "boolean" }, "errors": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Carts": { "title": "Carts", "required": [ "Account", "AppliedRuleActionInfo", "AppliedRuleInfo", "BillToAccount", "Id", "IsPricePending", "LineItems", "Name", "Pricelists", "ShipToAccount", "SummaryGroups" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "IsPricePending": { "type": "boolean" }, "LineItems": { "type": "array", "items": { "type": "object" } }, "Account": { "type": "string" }, "ShipToAccount": { "type": "string" }, "BillToAccount": { "type": "string" }, "AppliedRuleActionInfo": { "type": "array", "items": { "type": "object" } }, "SummaryGroups": { "type": "array", "items": { "type": "object" } }, "AppliedRuleInfo": { "type": "array", "items": { "type": "object" } } }, "example": { "title": "success", "status": 200, "data": {} } }, "CreateCart": { "title": "CreateCart", "required": [ "Account", "Id", "IsPricePending", "Name", "Pricelist" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "IsPricePending": { "type": "string" }, "Pricelist": { "type": "string" }, "Account": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "PromotionCart": { "title": "PromotionCart", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "boolean" } }, "example": { "title": "success", "status": 200, "data": {} } }, "DeleteRecord": { "title": "DeleteRecord", "required": [ "errors", "id", "success" ], "type": "object", "properties": { "id": { "type": "string" }, "success": { "type": "boolean" }, "errors": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "GetCartRules": { "title": "GetCartRules", "required": [ "ActionProductIds", "AppliedRuleInfo", "ConstraintRuleAction", "Id", "Message", "MessageType", "Name", "Pending", "SuggestedProductIds", "TriggeringProductIds" ], "type": "object", "properties": { "id": { "type": "string" }, "Name": { "type": "string" }, "ConstraintRuleAction": { "type": "array", "items": { "type": "object" } }, "AppliedRuleInfo": { "type": "array", "items": { "type": "object" } }, "Message": { "type": "string" }, "TriggeringProductIds": { "type": "string" }, "ActionProductIds": { "type": "string" }, "SuggestedProductIds": { "type": "string" }, "Pending": { "type": "boolean" }, "MessageType": { "type": "string" }, "IsTargetOption": { "type": "boolean" }, "ConfigurationId": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Describe": { "title": "Describe", "required": [ "fields" ], "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "picklistValues": { "type": "array", "items": { "type": "string" } }, "defaultValue": { "type": "string" } } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "Record": { "title": "Record", "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Data": { "type": "array", "items": { "type": "object" } } }, "example": { "title": "success", "status": 200, "data": {} } }, "Order": { "title": "Order", "required": [ "BillToAccountId", "Id", "Name", "OrderLineItems", "PriceListId", "PrimaryContactId", "ShipToAccountId" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "OrderLineItems": { "type": "array", "items": { "type": "object", "properties": { "LineType": { "type": "string" }, "NetPrice": { "type": "integer" }, "ListPrice": { "type": "integer" }, "LineNumber": { "type": "integer" }, "PriceType": { "type": "string" }, "ChargeType": { "type": "string" }, "Id": { "type": "string" }, "Orderid": { "type": "string" }, "Name": { "type": "string" }, "Status": { "type": "string" }, "Term": { "type": "integer" } } } }, "PrimaryContactId": { "type": "string" }, "PriceListId": { "type": "string" }, "ShipToAccountId": { "type": "string" }, "BillToAccountId": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Proposal": { "title": "Proposal", "required": [ "Account", "Id", "Name", "OwnerId", "PriceListId", "Primary_Contact", "Proposal_Category", "Proposal_Name" ], "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "OwnerId": { "type": "string" }, "Account": { "type": "string" }, "Primary_Contact": { "type": "string" }, "Proposal_Name": { "type": "string" }, "PriceListId": { "type": "string" }, "Proposal_Category": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Storefront": { "title": "Storefront", "required": [ "AssetActions", "ChannelType", "CurrencyIsoCode", "DefaultAccountforGuestUsers", "DefaultLocale", "DefaultPriceList", "EnableABO", "EnablePromotions", "EnableRequestQuote", "EnableTaxCalculations", "Id", "Name", "OwnerId", "StoreBanners" ], "type": "object", "properties": { "DefaultPriceList": { "type": "string" }, "StoreBanners": { "type": "array", "items": { "type": "object", "properties": { "Title": { "type": "string" }, "Image": { "type": "string" }, "Name": { "type": "string" }, "StorefrontId": { "type": "string" }, "Id": { "type": "string" } } } }, "Id": { "type": "string" }, "OwnerId": { "type": "string" }, "Name": { "type": "string" }, "CurrencyIsoCode": { "type": "string" }, "AssetActions": { "type": "string" }, "DefaultLocale": { "type": "string" }, "EnableTaxCalculations": { "type": "boolean" }, "EnableRequestQuote": { "type": "boolean" }, "EnableABO": { "type": "boolean" }, "EnablePromotions": { "type": "boolean" }, "DefaultAccountforGuestUsers": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "ChannelType": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "Authentication": { "title": "Authentication", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "AccessToken": { "title": "AccessToken", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "userId": { "type": "string" }, "acccessToken": { "type": "string" } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "ActiveUser": { "title": "ActiveUser", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Username": { "type": "string" }, "Id": { "type": "string" }, "Email": { "type": "string" }, "Name": { "type": "string" }, "Alias": { "type": "string" } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "GetChildren": { "title": "GetChildren", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "BusinessObjectId": { "type": "string" }, "Id": { "type": "string" } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "SuccessData": { "title": "SuccessData", "required": [ "data" ], "type": "object", "properties": { "data": { "type": "boolean" } }, "example": { "title": "success", "status": 200, "data": {} } }, "GetQuote": { "title": "GetQuote", "required": [ "Primary_Contact", "Account", "Proposal_Name", "Id", "Name", "OwnerId" ], "type": "object", "properties": { "Primary_Contact": { "type": "string" }, "Account": { "type": "string" }, "Proposal_Name": { "type": "string" }, "Approval_Stage": { "type": "string" }, "Grand_Total": { "type": "number" }, "Net_Amount": { "type": "number" }, "PriceListId": { "type": "string" }, "BillToAccountId": { "type": "string" }, "ABOType": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" }, "OwnerId": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "GetOrder": { "title": "GetOrder", "required": [ "SoldToAccountId", "ShipToAccountId", "PrimaryContactId", "Status", "Id", "Name", "OwnerId" ], "type": "object", "properties": { "OrderAmount": { "type": "number" }, "Status": { "type": "string" }, "SoldToAccountId": { "type": "string" }, "ShipToAccountId": { "type": "string" }, "PrimaryContactId": { "type": "string" }, "PriceListId": { "type": "string" }, "OrderDate": { "type": "string" }, "BillToAccountId": { "type": "string" }, "Id": { "type": "string" }, "Name": { "type": "string" }, "OwnerId": { "type": "string" } }, "example": { "title": "success", "status": 200, "data": {} } }, "SwapAsset": { "title": "SwapAsset", "type": "object", "properties": { "data": { "type": "object", "properties": { "Id": { "type": "object", "properties": { "Apttus_Config2__ConfigurationId__c": { "type": "string" }, "Apttus_Config2__ProductId__c": { "type": "string" }, "Apttus_Config2__LineType__c": { "type": "string" }, "Apttus_Config2__PrimaryLineNumber__c": { "type": "number" }, "Apttus_Config2__ItemSequence__c": { "type": "number" }, "Apttus_Config2__AssetLineItemId__c": { "type": "string" } } } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "TerminateAsset": { "title": "TerminateAsset", "type": "object", "properties": { "Id": { "type": "object", "properties": { "Apttus_Config2__ConfigurationId__c": { "type": "string" }, "Apttus_Config2__Quantity__c": { "type": "number" }, "Apttus_Config2__PriceListId__c": { "type": "string" }, "Apttus_Config2__LineType__c": { "type": "string" }, "Apttus_Config2__LineStatus__c": { "type": "string" } } } }, "example": { "title": "success", "status": 200, "data": {} } }, "ChangeAsset": { "title": "ChangeAsset", "type": "object", "properties": { "data": { "type": "object", "properties": { "pageErrors": { "type": "string" }, "nextStep": { "type": "number" }, "hasError": { "type": "boolean" } } } }, "example": { "title": "success", "status": 200, "data": {} } } }, "securitySchemes": { "httpBasic": { "type": "http", "scheme": "basic" } } } }