@salesforce/lds-adapters-industries-cpq 0.1.0-dev1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +82 -0
- package/dist/es/es2018/industries-cpq.js +9433 -0
- package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/adapters/bulkProductDetails.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/categoryDetails.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/categoryList.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/adapters/configure.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/createCart.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/createCartItems.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/createFavorite.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/adapters/createRule.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/deleteFavorite.d.ts +14 -0
- package/dist/es/es2018/types/src/generated/adapters/getCart.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getFavorite.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getFavoriteId.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/guidedSelectionProductList.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/adapters/preview.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/priceCart.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/productDetails.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/productList.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/searchProductList.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/shareFavorite.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/smartProductSelection.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/adapters/updateCart.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/updateCartItems.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/updateFavorite.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/adapters/updateRule.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/validateRule.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/resources/deleteConnectCpqConfiguratorSavedConfigurationById.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCpqCartsByCartId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCpqConfiguratorSavedConfiguration.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectCpqConfiguratorSavedConfigurationById.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectCpqCartsByCartId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectCpqCartsItemsByCartId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectCpqCartsPriceByCartId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqCarts.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqCartsItemsByCartId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqCategories.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqCategoriesByCategoryId.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorActionsConfigure.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorActionsCreateRule.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorActionsUpdateRule.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorActionsValidateRule.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorFavoriteActionsShare.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqConfiguratorSavedConfiguration.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqPreview.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProducts.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProductsBulk.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProductsByProductId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProductsGuidedSelection.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProductsSearch.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectCpqProductsSmartSelection.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/putConnectCpqConfiguratorSavedConfigurationById.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/types/AdditionalFieldsOutputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ApiStatusOutputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/AttributeCategoryOutputRepresentation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/AttributePickListOutputRepresentation.d.ts +47 -0
- package/dist/es/es2018/types/src/generated/types/AttributePickListValueOutputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/BulkProductDetailsInput.d.ts +65 -0
- package/dist/es/es2018/types/src/generated/types/CartItemOutputRepresentation.d.ts +60 -0
- package/dist/es/es2018/types/src/generated/types/CartItemsOutputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/CartPricingTotalOutputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/CategoryDetailsInputRepresentation.d.ts +63 -0
- package/dist/es/es2018/types/src/generated/types/CategoryDetailsOutputRepresentation.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/types/CategoryListInputRepresentation.d.ts +69 -0
- package/dist/es/es2018/types/src/generated/types/CategoryListOutputRepresentation.d.ts +63 -0
- package/dist/es/es2018/types/src/generated/types/CategoryOutputRepresentation.d.ts +60 -0
- package/dist/es/es2018/types/src/generated/types/ConditionCollectionInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ConditionInformationCollectionInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ConditionInformationInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ConditionInputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAddedNodeInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAdditionalFieldsOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAttributeCategoryOutputRepresentation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAttributeOutputRepresentation.d.ts +109 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAttributePicklistOutputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorAttributePicklistValueOutputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorDeletedNodeInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorInputRepresentation.d.ts +64 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorInputRepresentationWrapper.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorOptionsInputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorOutputRepresentation.d.ts +63 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorPriceOutputRepresentation.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorPricingModelOutputRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductCatalogOutputRepresentation.d.ts +114 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductClassificationOutputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductComponentGroupOutputRepresentation.d.ts +63 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductRelatedComponentOutputRepresentation.d.ts +79 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductSellingModelOptionOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorProductSellingModelOutputRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorQualificationContextOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorQuantityInfoOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorRuleInputRepresentation.d.ts +64 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorRuleOutputRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorRuleValidatorInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorRuleValidatorOutputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorUnitOfMeasureOutputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/ConfiguratorUpdatedNodeInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/CpqBaseBulkDetailsOutput.d.ts +51 -0
- package/dist/es/es2018/types/src/generated/types/CpqBaseDetailsOutputRepresentation.d.ts +45 -0
- package/dist/es/es2018/types/src/generated/types/CpqBaseListOutputRepresentation.d.ts +61 -0
- package/dist/es/es2018/types/src/generated/types/CpqMessageOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartInputRepresentation.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartItemsInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartItemsInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartItemsOutputRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartOutputRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/CreateCartRequestWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CreateFavoriteOutputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/FacetValueRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FavoriteInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/FavoriteListOutputRepresenation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/FavoriteOutputRepresenation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/FilterCriteriaInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/FilterInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/GetCartOutputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/GuidedSelectionInputRepresentation.d.ts +103 -0
- package/dist/es/es2018/types/src/generated/types/GuidedSelectionOutputRepresentation.d.ts +67 -0
- package/dist/es/es2018/types/src/generated/types/GuidedSelectionSearchTermInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/GuidedSelectionSearchTermOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/PreviewInputRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/PreviewInputRepresentationWrapper.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/PriceCartInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PriceCartInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/PricingModelOutputRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/PricingTotalOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ProductAttributeOutputRepresentation.d.ts +113 -0
- package/dist/es/es2018/types/src/generated/types/ProductClassificationOutputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ProductComponentGroupOutputRepresentation.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/ProductConfigurationInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ProductDataInput.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ProductDeltaConfigurationInputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/ProductDetailsInputRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/ProductDetailsInputRepresentationWrapper.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ProductDetailsOutputRepresentation.d.ts +126 -0
- package/dist/es/es2018/types/src/generated/types/ProductListInputRepresentation.d.ts +61 -0
- package/dist/es/es2018/types/src/generated/types/ProductListInputRepresentationWrapper.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ProductListOutputRepresentation.d.ts +120 -0
- package/dist/es/es2018/types/src/generated/types/ProductOutputRepresentation.d.ts +116 -0
- package/dist/es/es2018/types/src/generated/types/ProductPricesOutputRepresentation.d.ts +47 -0
- package/dist/es/es2018/types/src/generated/types/ProductQuantityOutputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ProductRelatedComponentOutputRepresentation.d.ts +79 -0
- package/dist/es/es2018/types/src/generated/types/ProductSellingModelOptionOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ProductSellingModelOutputRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/ProductSpecificationRecordTypeOutputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ProductSpecificationTypeOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ProductVariantAttributeOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ProductVariantAttributeSetOutputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/ProductVariantAttributeValueOutputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/PromotionOutputRepresentation.d.ts +61 -0
- package/dist/es/es2018/types/src/generated/types/QocBaseOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/QualificationContextOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/RelatedObjectFilterInputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/ResourceValueCollectionInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/RuleActionCollectionInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/RuleActionInputRepresentation.d.ts +65 -0
- package/dist/es/es2018/types/src/generated/types/RuleCriteriaCollectionInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/RuleCriteriaInputRepresentation.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/SearchProductsFacetRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/SearchProductsInputRepresentation.d.ts +64 -0
- package/dist/es/es2018/types/src/generated/types/SearchProductsInputRepresentationWrapper.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SearchProductsOutputRepresentation.d.ts +65 -0
- package/dist/es/es2018/types/src/generated/types/ShareFavoriteInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ShareFavoriteOutputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/SmartSelectionInputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/SmartSelectionOutputRepresentation.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/SmartSelectionSearchInputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartItemsInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartItemsInputRepresentationWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartItemsOutputRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/UpdateCartOutputRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/UpdateFavoriteInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/UpdateFavoriteOutputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/ValidateCartOutputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/ValidationResultOutputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
- package/package.json +76 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +9596 -0
- package/src/raml/api.raml +4269 -0
- package/src/raml/luvio.raml +207 -0
|
@@ -0,0 +1,4269 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '59.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v66.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
AdditionalFieldsOutputRepresentation:
|
|
29
|
+
description: Output representation for custom fields
|
|
30
|
+
type: object
|
|
31
|
+
properties:
|
|
32
|
+
fieldApiName:
|
|
33
|
+
description: Api name of the custom field
|
|
34
|
+
type: string
|
|
35
|
+
required: false
|
|
36
|
+
fieldName:
|
|
37
|
+
description: Name of the custom field
|
|
38
|
+
type: string
|
|
39
|
+
required: false
|
|
40
|
+
value:
|
|
41
|
+
description: Value of the custom field
|
|
42
|
+
type: string
|
|
43
|
+
required: false
|
|
44
|
+
ApiStatusOutputRepresentation:
|
|
45
|
+
description: API Status Output Representation
|
|
46
|
+
type: object
|
|
47
|
+
properties:
|
|
48
|
+
messages:
|
|
49
|
+
description: API status messages
|
|
50
|
+
type: array
|
|
51
|
+
required: false
|
|
52
|
+
items:
|
|
53
|
+
type: CpqMessageOutputRepresentation
|
|
54
|
+
statusCode:
|
|
55
|
+
description: Status Code
|
|
56
|
+
type: string
|
|
57
|
+
statusMessage:
|
|
58
|
+
description: Status Message - Display label for API status
|
|
59
|
+
type: string
|
|
60
|
+
required: false
|
|
61
|
+
AttributeCategoryOutputRepresentation:
|
|
62
|
+
description: Output Representation for AttributeCategory
|
|
63
|
+
type: object
|
|
64
|
+
properties:
|
|
65
|
+
code:
|
|
66
|
+
description: Code of the attribute category
|
|
67
|
+
type: string
|
|
68
|
+
required: false
|
|
69
|
+
description:
|
|
70
|
+
description: Description of the attribute category
|
|
71
|
+
type: string
|
|
72
|
+
required: false
|
|
73
|
+
name:
|
|
74
|
+
description: Name of the attribute category
|
|
75
|
+
type: string
|
|
76
|
+
required: false
|
|
77
|
+
records:
|
|
78
|
+
description: Attributes in this category
|
|
79
|
+
type: array
|
|
80
|
+
required: false
|
|
81
|
+
items:
|
|
82
|
+
type: ProductAttributeOutputRepresentation
|
|
83
|
+
status:
|
|
84
|
+
description: Status of the attribute category
|
|
85
|
+
type: string
|
|
86
|
+
required: false
|
|
87
|
+
totalSize:
|
|
88
|
+
description: Total Size of attributes in this category
|
|
89
|
+
type: integer
|
|
90
|
+
required: false
|
|
91
|
+
usageType:
|
|
92
|
+
description: Usage Type of the attribute category
|
|
93
|
+
type: string
|
|
94
|
+
required: false
|
|
95
|
+
id:
|
|
96
|
+
description: Attribute code
|
|
97
|
+
type: string
|
|
98
|
+
required: false
|
|
99
|
+
AttributePickListOutputRepresentation:
|
|
100
|
+
description: Attribute picklist output representation
|
|
101
|
+
type: object
|
|
102
|
+
properties:
|
|
103
|
+
code:
|
|
104
|
+
description: Code of attribute picklist
|
|
105
|
+
type: string
|
|
106
|
+
required: false
|
|
107
|
+
description:
|
|
108
|
+
description: Description of attribute picklist
|
|
109
|
+
type: string
|
|
110
|
+
required: false
|
|
111
|
+
id:
|
|
112
|
+
description: Id of attribute picklist
|
|
113
|
+
type: string
|
|
114
|
+
required: false
|
|
115
|
+
name:
|
|
116
|
+
description: Name of attribute picklist
|
|
117
|
+
type: string
|
|
118
|
+
required: false
|
|
119
|
+
status:
|
|
120
|
+
description: Status of attribute picklist - Active/InActive
|
|
121
|
+
type: string
|
|
122
|
+
required: false
|
|
123
|
+
values:
|
|
124
|
+
description: List of values of attribute picklist
|
|
125
|
+
type: array
|
|
126
|
+
required: false
|
|
127
|
+
items:
|
|
128
|
+
type: AttributePickListValueOutputRepresentation
|
|
129
|
+
dataType:
|
|
130
|
+
description: DataType of attribute picklist
|
|
131
|
+
type: string
|
|
132
|
+
required: false
|
|
133
|
+
AttributePickListValueOutputRepresentation:
|
|
134
|
+
description: Attribute picklist value output representation
|
|
135
|
+
type: object
|
|
136
|
+
properties:
|
|
137
|
+
code:
|
|
138
|
+
description: Code of attribute picklist value
|
|
139
|
+
type: string
|
|
140
|
+
required: false
|
|
141
|
+
description:
|
|
142
|
+
description: Description of attribute picklist value
|
|
143
|
+
type: string
|
|
144
|
+
required: false
|
|
145
|
+
displayValue:
|
|
146
|
+
description: Display value of attribute picklist value
|
|
147
|
+
type: string
|
|
148
|
+
required: false
|
|
149
|
+
id:
|
|
150
|
+
description: Id of attribute picklist value
|
|
151
|
+
type: string
|
|
152
|
+
required: false
|
|
153
|
+
isBooleanValue:
|
|
154
|
+
description: Is the attribute picklist value a boolean
|
|
155
|
+
type: boolean
|
|
156
|
+
required: false
|
|
157
|
+
label:
|
|
158
|
+
description: Label of attribute picklist value
|
|
159
|
+
type: string
|
|
160
|
+
required: false
|
|
161
|
+
name:
|
|
162
|
+
description: Name of attribute picklist value
|
|
163
|
+
type: string
|
|
164
|
+
required: false
|
|
165
|
+
sequence:
|
|
166
|
+
description: Sequence of attribute picklist value
|
|
167
|
+
type: integer
|
|
168
|
+
required: false
|
|
169
|
+
status:
|
|
170
|
+
description: Status of attribute picklist value - Active/InActive
|
|
171
|
+
type: string
|
|
172
|
+
required: false
|
|
173
|
+
textValue:
|
|
174
|
+
description: Text value of the attribute picklist value
|
|
175
|
+
type: string
|
|
176
|
+
required: false
|
|
177
|
+
ConditionCollectionInputRepresentation:
|
|
178
|
+
description: Collection of attribute / tag conditions
|
|
179
|
+
type: object
|
|
180
|
+
properties:
|
|
181
|
+
conditions:
|
|
182
|
+
description: Attribute / tag conditions node
|
|
183
|
+
type: array
|
|
184
|
+
required: false # TODO hand rolled. W-9275477
|
|
185
|
+
items:
|
|
186
|
+
type: object
|
|
187
|
+
ConditionInformationCollectionInputRepresentation:
|
|
188
|
+
type: object
|
|
189
|
+
description: Collection of condition information node
|
|
190
|
+
properties:
|
|
191
|
+
conditionInformationList:
|
|
192
|
+
description: Condition Information node
|
|
193
|
+
type: array
|
|
194
|
+
required: false # TODO hand rolled. W-9275477
|
|
195
|
+
items:
|
|
196
|
+
type: ConditionInformationInputRepresentation
|
|
197
|
+
ConditionInformationInputRepresentation:
|
|
198
|
+
type: object
|
|
199
|
+
description: Input Representation for condition information
|
|
200
|
+
properties:
|
|
201
|
+
name:
|
|
202
|
+
description: Name of the information object
|
|
203
|
+
type: string
|
|
204
|
+
required: false # TODO hand rolled. W-9275477
|
|
205
|
+
type:
|
|
206
|
+
description: Type of information
|
|
207
|
+
type: string
|
|
208
|
+
required: false # TODO hand rolled. W-9275477
|
|
209
|
+
enum:
|
|
210
|
+
- Attribute
|
|
211
|
+
- Enum
|
|
212
|
+
- Tag
|
|
213
|
+
values:
|
|
214
|
+
description: Values of the source / target information
|
|
215
|
+
type: array
|
|
216
|
+
required: false # TODO hand rolled. W-9275477
|
|
217
|
+
items:
|
|
218
|
+
type: string
|
|
219
|
+
ConditionInputRepresentation:
|
|
220
|
+
description: Input Representation for attribute / tag condition
|
|
221
|
+
type: object
|
|
222
|
+
properties:
|
|
223
|
+
attributeId:
|
|
224
|
+
description: Id of the attribute
|
|
225
|
+
type: string
|
|
226
|
+
required: false # TODO hand rolled. W-9275477
|
|
227
|
+
attributeName:
|
|
228
|
+
description: Name of the attribute
|
|
229
|
+
type: string
|
|
230
|
+
required: false # TODO hand rolled. W-9275477
|
|
231
|
+
attributePicklistValueId:
|
|
232
|
+
description: Attribute Picklist Option Id
|
|
233
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
234
|
+
required: false # TODO hand rolled. W-9275477
|
|
235
|
+
behaviorTypeLock:
|
|
236
|
+
description: Boolean to indicate whether an item is locked or not
|
|
237
|
+
type: boolean
|
|
238
|
+
required: false # TODO hand rolled. W-9275477
|
|
239
|
+
conditionIndex:
|
|
240
|
+
description: Index of the attribute / tag condition
|
|
241
|
+
type: integer
|
|
242
|
+
required: false # TODO hand rolled. W-9275477
|
|
243
|
+
contextTagName:
|
|
244
|
+
description: Name of the context tag resource
|
|
245
|
+
type: string
|
|
246
|
+
required: false # TODO hand rolled. W-9275477
|
|
247
|
+
dataType:
|
|
248
|
+
description: Data type of the attribute / tag
|
|
249
|
+
type: string
|
|
250
|
+
required: false # TODO hand rolled. W-9275477
|
|
251
|
+
enum:
|
|
252
|
+
- Boolean
|
|
253
|
+
- Currency
|
|
254
|
+
- Date
|
|
255
|
+
- DateTime
|
|
256
|
+
- Integer
|
|
257
|
+
- MultiPicklist
|
|
258
|
+
- Number
|
|
259
|
+
- Percent
|
|
260
|
+
- Picklist
|
|
261
|
+
- String
|
|
262
|
+
- Text
|
|
263
|
+
- Lookup
|
|
264
|
+
operator:
|
|
265
|
+
description: operator of the condition
|
|
266
|
+
type: string
|
|
267
|
+
required: false # TODO hand rolled. W-9275477
|
|
268
|
+
enum:
|
|
269
|
+
- Contains
|
|
270
|
+
- DoesNotContain
|
|
271
|
+
- Equals
|
|
272
|
+
- GreaterThan
|
|
273
|
+
- GreaterThanOrEquals
|
|
274
|
+
- In
|
|
275
|
+
- IsNotNull
|
|
276
|
+
- IsNull
|
|
277
|
+
- LessThan
|
|
278
|
+
- LessThanOrEquals
|
|
279
|
+
- NotEquals
|
|
280
|
+
- NotIn
|
|
281
|
+
type:
|
|
282
|
+
description: Type of condition
|
|
283
|
+
type: string
|
|
284
|
+
required: false # TODO hand rolled. W-9275477
|
|
285
|
+
enum:
|
|
286
|
+
- Attribute
|
|
287
|
+
- Tag
|
|
288
|
+
- Enum
|
|
289
|
+
values:
|
|
290
|
+
description: Values of the attribute / tag
|
|
291
|
+
type: array
|
|
292
|
+
required: false # TODO hand rolled. W-9275477
|
|
293
|
+
items:
|
|
294
|
+
type: string
|
|
295
|
+
ConfiguratorAddedNodeInputRepresentation:
|
|
296
|
+
description: Input Representation for Added Nodes to the Configurator
|
|
297
|
+
type: object
|
|
298
|
+
properties:
|
|
299
|
+
path:
|
|
300
|
+
description: Path to the Added Node
|
|
301
|
+
type: array
|
|
302
|
+
required: false # TODO hand rolled. W-9275477
|
|
303
|
+
items:
|
|
304
|
+
type: string
|
|
305
|
+
addedObject:
|
|
306
|
+
description: Added Node Details
|
|
307
|
+
type: any # TODO hand rolled. W-9320402
|
|
308
|
+
required: true # TODO hand rolled. W-9275477
|
|
309
|
+
ConfiguratorAdditionalFieldsOutputRepresentation:
|
|
310
|
+
description: Output Representation for the Configurator API's Additional Fields
|
|
311
|
+
type: object
|
|
312
|
+
properties:
|
|
313
|
+
contextAttributeApiName:
|
|
314
|
+
description: Mapped context attribute API name
|
|
315
|
+
type: string
|
|
316
|
+
required: false # TODO hand rolled. W-9275477
|
|
317
|
+
fieldApiName:
|
|
318
|
+
description: Field Api Name
|
|
319
|
+
type: string
|
|
320
|
+
required: false # TODO hand rolled. W-9275477
|
|
321
|
+
fieldName:
|
|
322
|
+
description: Field Name
|
|
323
|
+
type: string
|
|
324
|
+
required: false # TODO hand rolled. W-9275477
|
|
325
|
+
value:
|
|
326
|
+
description: Field Value
|
|
327
|
+
type: string
|
|
328
|
+
required: false # TODO hand rolled. W-9275477
|
|
329
|
+
ConfiguratorAttributeCategoryOutputRepresentation:
|
|
330
|
+
description: Output Representation for the Configurator API's Attribute Category
|
|
331
|
+
type: object
|
|
332
|
+
properties:
|
|
333
|
+
attributes:
|
|
334
|
+
description: Attributes of this attribute category
|
|
335
|
+
type: array
|
|
336
|
+
required: false # TODO hand rolled. W-9275477
|
|
337
|
+
items:
|
|
338
|
+
type: ConfiguratorAttributeOutputRepresentation
|
|
339
|
+
code:
|
|
340
|
+
description: Code of this attribute category
|
|
341
|
+
type: string
|
|
342
|
+
required: false # TODO hand rolled. W-9275477
|
|
343
|
+
description:
|
|
344
|
+
description: Description of this attribute category
|
|
345
|
+
type: string
|
|
346
|
+
required: false # TODO hand rolled. W-9275477
|
|
347
|
+
id:
|
|
348
|
+
description: ID of this attribute category
|
|
349
|
+
type: string
|
|
350
|
+
required: false # TODO hand rolled. W-9275477
|
|
351
|
+
name:
|
|
352
|
+
description: Name of this attribute category
|
|
353
|
+
type: string
|
|
354
|
+
required: false # TODO hand rolled. W-9275477
|
|
355
|
+
status:
|
|
356
|
+
description: Status of this attribute category
|
|
357
|
+
type: string
|
|
358
|
+
required: false # TODO hand rolled. W-9275477
|
|
359
|
+
totalSize:
|
|
360
|
+
description: Total Size of this attribute category
|
|
361
|
+
type: integer
|
|
362
|
+
required: false # TODO hand rolled. W-9275477
|
|
363
|
+
usageType:
|
|
364
|
+
description: Usage Type of this attribute category
|
|
365
|
+
type: string
|
|
366
|
+
required: false # TODO hand rolled. W-9275477
|
|
367
|
+
ConfiguratorAttributeOutputRepresentation:
|
|
368
|
+
description: Output Representation for the Configurator API's Attributes
|
|
369
|
+
type: object
|
|
370
|
+
properties:
|
|
371
|
+
attributeCategoryId:
|
|
372
|
+
description: Attribute Category ID of the attribute
|
|
373
|
+
type: string
|
|
374
|
+
required: false # TODO hand rolled. W-9275477
|
|
375
|
+
attributeNameOverride:
|
|
376
|
+
description: attribute name override of the attribute
|
|
377
|
+
type: string
|
|
378
|
+
required: false # TODO hand rolled. W-9275477
|
|
379
|
+
attributePicklist:
|
|
380
|
+
description: Attribute Picklist Values of this attribute
|
|
381
|
+
type: ConfiguratorAttributePicklistOutputRepresentation
|
|
382
|
+
required: false # TODO hand rolled. W-9275477
|
|
383
|
+
code:
|
|
384
|
+
description: Code of the attribute
|
|
385
|
+
type: string
|
|
386
|
+
required: false # TODO hand rolled. W-9275477
|
|
387
|
+
dataType:
|
|
388
|
+
description: Data Type of the attribute
|
|
389
|
+
type: string
|
|
390
|
+
required: false # TODO hand rolled. W-9275477
|
|
391
|
+
defaultHelpText:
|
|
392
|
+
description: Default Value Help Text of the attribute
|
|
393
|
+
type: string
|
|
394
|
+
required: false # TODO hand rolled. W-9275477
|
|
395
|
+
defaultValue:
|
|
396
|
+
description: Default Value of the attribute
|
|
397
|
+
type: string
|
|
398
|
+
required: false # TODO hand rolled. W-9275477
|
|
399
|
+
description:
|
|
400
|
+
description: Description of the attribute
|
|
401
|
+
type: string
|
|
402
|
+
required: false # TODO hand rolled. W-9275477
|
|
403
|
+
id:
|
|
404
|
+
description: ID of the attribute
|
|
405
|
+
type: string
|
|
406
|
+
required: false # TODO hand rolled. W-9275477
|
|
407
|
+
isCloneable:
|
|
408
|
+
description: Is this attribute cloneable
|
|
409
|
+
type: boolean
|
|
410
|
+
required: false # TODO hand rolled. W-9275477
|
|
411
|
+
isConfigurable:
|
|
412
|
+
description: Is this attribute configurable
|
|
413
|
+
type: boolean
|
|
414
|
+
required: false # TODO hand rolled. W-9275477
|
|
415
|
+
isEncrypted:
|
|
416
|
+
description: Is this attribute encrypted
|
|
417
|
+
type: boolean
|
|
418
|
+
required: false # TODO hand rolled. W-9275477
|
|
419
|
+
isHidden:
|
|
420
|
+
description: Is this attribute hidden
|
|
421
|
+
type: boolean
|
|
422
|
+
required: false # TODO hand rolled. W-9275477
|
|
423
|
+
isPriceImpacting:
|
|
424
|
+
description: Is this attribute price impacting
|
|
425
|
+
type: boolean
|
|
426
|
+
required: false # TODO hand rolled. W-9275477
|
|
427
|
+
isReadOnly:
|
|
428
|
+
description: Is this attribute read only
|
|
429
|
+
type: boolean
|
|
430
|
+
required: false # TODO hand rolled. W-9275477
|
|
431
|
+
isRequired:
|
|
432
|
+
description: Is this attribute required
|
|
433
|
+
type: boolean
|
|
434
|
+
required: false # TODO hand rolled. W-9275477
|
|
435
|
+
label:
|
|
436
|
+
description: Label of the attribute
|
|
437
|
+
type: string
|
|
438
|
+
required: false # TODO hand rolled. W-9275477
|
|
439
|
+
name:
|
|
440
|
+
description: Name of the attribute
|
|
441
|
+
type: string
|
|
442
|
+
required: false # TODO hand rolled. W-9275477
|
|
443
|
+
sequence:
|
|
444
|
+
description: Sequence Values of this attribute
|
|
445
|
+
type: integer
|
|
446
|
+
required: false # TODO hand rolled. W-9275477
|
|
447
|
+
status:
|
|
448
|
+
description: Status of the attribute
|
|
449
|
+
type: string
|
|
450
|
+
required: false # TODO hand rolled. W-9275477
|
|
451
|
+
userValue:
|
|
452
|
+
description: User Value of this attribute
|
|
453
|
+
type: string
|
|
454
|
+
required: false # TODO hand rolled. W-9275477
|
|
455
|
+
valueDescription:
|
|
456
|
+
description: value description of the attribute
|
|
457
|
+
type: string
|
|
458
|
+
required: false # TODO hand rolled. W-9275477
|
|
459
|
+
minimumValue:
|
|
460
|
+
description: minimum value of the attribute
|
|
461
|
+
type: string
|
|
462
|
+
required: false
|
|
463
|
+
maximumValue:
|
|
464
|
+
description: maximum value of the attribute
|
|
465
|
+
type: string
|
|
466
|
+
required: false
|
|
467
|
+
stepValue:
|
|
468
|
+
description: step increment/decrement value of the attribute
|
|
469
|
+
type: string
|
|
470
|
+
required: false
|
|
471
|
+
valueDecoder:
|
|
472
|
+
description: parsable decoder of the attribute
|
|
473
|
+
type: string
|
|
474
|
+
required: false
|
|
475
|
+
displayType:
|
|
476
|
+
description: display type of the attribute
|
|
477
|
+
type: string
|
|
478
|
+
required: false
|
|
479
|
+
unitOfMeasure:
|
|
480
|
+
description: UnitOfMeasure
|
|
481
|
+
type: ConfiguratorUnitOfMeasureOutputRepresentation
|
|
482
|
+
required: false # TODO hand rolled. W-9275477
|
|
483
|
+
ConfiguratorAttributePicklistOutputRepresentation:
|
|
484
|
+
description: Output Representation for the Configurator API's Attribute Picklist
|
|
485
|
+
type: object
|
|
486
|
+
properties:
|
|
487
|
+
description:
|
|
488
|
+
description: Description of the attribute pickist
|
|
489
|
+
type: string
|
|
490
|
+
required: false # TODO hand rolled. W-9275477
|
|
491
|
+
id:
|
|
492
|
+
description: ID of the attribute pickist
|
|
493
|
+
type: string
|
|
494
|
+
required: false # TODO hand rolled. W-9275477
|
|
495
|
+
name:
|
|
496
|
+
description: Name of the attribute pickist
|
|
497
|
+
type: string
|
|
498
|
+
required: false # TODO hand rolled. W-9275477
|
|
499
|
+
status:
|
|
500
|
+
description: Status of the attribute pickist
|
|
501
|
+
type: string
|
|
502
|
+
required: false # TODO hand rolled. W-9275477
|
|
503
|
+
values:
|
|
504
|
+
description: Values of the attribute picklist
|
|
505
|
+
type: array
|
|
506
|
+
required: false # TODO hand rolled. W-9275477
|
|
507
|
+
items:
|
|
508
|
+
type: ConfiguratorAttributePicklistValueOutputRepresentation
|
|
509
|
+
ConfiguratorAttributePicklistValueOutputRepresentation:
|
|
510
|
+
description: Output Representation for the Configurator API's Attribute Picklist
|
|
511
|
+
Value
|
|
512
|
+
type: object
|
|
513
|
+
properties:
|
|
514
|
+
code:
|
|
515
|
+
description: Code of the attribute value
|
|
516
|
+
type: string
|
|
517
|
+
required: false # TODO hand rolled. W-9275477
|
|
518
|
+
description:
|
|
519
|
+
description: Description of the attribute value
|
|
520
|
+
type: string
|
|
521
|
+
required: false # TODO hand rolled. W-9275477
|
|
522
|
+
displayValue:
|
|
523
|
+
description: Display value of the attribute value
|
|
524
|
+
type: string
|
|
525
|
+
required: false # TODO hand rolled. W-9275477
|
|
526
|
+
id:
|
|
527
|
+
description: ID of the attribute value
|
|
528
|
+
type: string
|
|
529
|
+
required: false # TODO hand rolled. W-9275477
|
|
530
|
+
isBooleanValue:
|
|
531
|
+
description: Is this attribute value a boolean
|
|
532
|
+
type: boolean
|
|
533
|
+
required: false # TODO hand rolled. W-9275477
|
|
534
|
+
label:
|
|
535
|
+
description: Label of the attribute value
|
|
536
|
+
type: string
|
|
537
|
+
required: false # TODO hand rolled. W-9275477
|
|
538
|
+
name:
|
|
539
|
+
description: Name of the attribute value
|
|
540
|
+
type: string
|
|
541
|
+
required: false # TODO hand rolled. W-9275477
|
|
542
|
+
sequence:
|
|
543
|
+
description: Sequence of the attribute value
|
|
544
|
+
type: integer
|
|
545
|
+
required: false # TODO hand rolled. W-9275477
|
|
546
|
+
status:
|
|
547
|
+
description: Status of the attribute value
|
|
548
|
+
type: string
|
|
549
|
+
required: false # TODO hand rolled. W-9275477
|
|
550
|
+
textValue:
|
|
551
|
+
description: Text value of the attribute value
|
|
552
|
+
type: string
|
|
553
|
+
required: false # TODO hand rolled. W-9275477
|
|
554
|
+
ConfiguratorDeletedNodeInputRepresentation:
|
|
555
|
+
description: Input Representation for Deleted Nodes to the Configurator
|
|
556
|
+
type: object
|
|
557
|
+
properties:
|
|
558
|
+
path:
|
|
559
|
+
description: Path to the Deleted Node
|
|
560
|
+
type: array
|
|
561
|
+
required: false # TODO hand rolled. W-9275477
|
|
562
|
+
items:
|
|
563
|
+
type: string
|
|
564
|
+
ConfiguratorInputRepresentation:
|
|
565
|
+
description: Input Representation for the Configurator API
|
|
566
|
+
type: object
|
|
567
|
+
properties:
|
|
568
|
+
addedNodes:
|
|
569
|
+
description: List of Added Nodes to the Configurator
|
|
570
|
+
type: array
|
|
571
|
+
required: false # TODO hand rolled. W-9275477
|
|
572
|
+
items:
|
|
573
|
+
type: ConfiguratorAddedNodeInputRepresentation
|
|
574
|
+
configuratorOptions:
|
|
575
|
+
description: Configurator Options
|
|
576
|
+
type: ConfiguratorOptionsInputRepresentation
|
|
577
|
+
required: false # TODO hand rolled. W-9275477
|
|
578
|
+
contextResponseType:
|
|
579
|
+
description: Context Response Type
|
|
580
|
+
type: string
|
|
581
|
+
enum:
|
|
582
|
+
- Delta
|
|
583
|
+
- Full
|
|
584
|
+
- None
|
|
585
|
+
- Product
|
|
586
|
+
required: false # TODO hand rolled. W-9275477
|
|
587
|
+
correlationId:
|
|
588
|
+
description: Correlation ID
|
|
589
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
590
|
+
required: false # TODO hand rolled. W-9275477
|
|
591
|
+
deletedNodes:
|
|
592
|
+
description: List of Deleted node paths to the Configurator
|
|
593
|
+
type: array
|
|
594
|
+
required: false # TODO hand rolled. W-9275477
|
|
595
|
+
items:
|
|
596
|
+
type: ConfiguratorDeletedNodeInputRepresentation
|
|
597
|
+
qualificationContext:
|
|
598
|
+
description: Qualification context
|
|
599
|
+
type: object
|
|
600
|
+
required: false # TODO hand rolled. W-9275477
|
|
601
|
+
transactionContextId:
|
|
602
|
+
description: Transaction Context ID
|
|
603
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
604
|
+
required: false # TODO hand rolled. W-9275477
|
|
605
|
+
transactionId:
|
|
606
|
+
description: Transaction ID
|
|
607
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
608
|
+
required: false # TODO hand rolled. W-9275477
|
|
609
|
+
transactionLineId:
|
|
610
|
+
description: Transaction Line ID
|
|
611
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
612
|
+
required: false # TODO hand rolled. W-9275477
|
|
613
|
+
updatedNodes:
|
|
614
|
+
description: List of Updated Nodes to the Configurator
|
|
615
|
+
type: array
|
|
616
|
+
required: false # TODO hand rolled. W-9275477
|
|
617
|
+
items:
|
|
618
|
+
type: ConfiguratorUpdatedNodeInputRepresentation
|
|
619
|
+
contextMappingId:
|
|
620
|
+
description: Context Mapping Id
|
|
621
|
+
type: string
|
|
622
|
+
required: false # TODO hand rolled. W-9275477
|
|
623
|
+
dataSeed:
|
|
624
|
+
description: Data Seed
|
|
625
|
+
type: string
|
|
626
|
+
required: false # TODO hand rolled. W-9275477
|
|
627
|
+
# TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
628
|
+
ConfiguratorInputRepresentationWrapper:
|
|
629
|
+
description: Configurator Input Representation Wrapper
|
|
630
|
+
type: object
|
|
631
|
+
properties:
|
|
632
|
+
configuratorInput:
|
|
633
|
+
description: Key for api call
|
|
634
|
+
type: ConfiguratorInputRepresentation
|
|
635
|
+
ConfiguratorOptionsInputRepresentation:
|
|
636
|
+
description: Input Representation for the Configurator Options
|
|
637
|
+
type: object
|
|
638
|
+
properties:
|
|
639
|
+
addDefaultConfiguration:
|
|
640
|
+
description: Whether to add default configurations
|
|
641
|
+
type: boolean
|
|
642
|
+
required: false # TODO hand rolled. W-9275477
|
|
643
|
+
executeConfigurationRules:
|
|
644
|
+
description: Whether to execute Configuration Rules
|
|
645
|
+
type: boolean
|
|
646
|
+
required: false # TODO hand rolled. W-9275477
|
|
647
|
+
executePricing:
|
|
648
|
+
description: Whether to execute pricing
|
|
649
|
+
type: boolean
|
|
650
|
+
required: false # TODO hand rolled. W-9275477
|
|
651
|
+
pricingProcedure:
|
|
652
|
+
description: Pricing Procedure
|
|
653
|
+
type: string
|
|
654
|
+
required: false # TODO hand rolled. W-9275477
|
|
655
|
+
qualifyAllProductsInTransaction:
|
|
656
|
+
description: Whether to run qualification rules on all products in the context
|
|
657
|
+
type: boolean
|
|
658
|
+
required: false # TODO hand rolled. W-9275477
|
|
659
|
+
returnProductCatalogData:
|
|
660
|
+
description: Whether to return Product Catalog Data
|
|
661
|
+
type: boolean
|
|
662
|
+
required: false # TODO hand rolled. W-9275477
|
|
663
|
+
validateAmendRenewCancel:
|
|
664
|
+
description: Whether to run amend/renew/cancel related validations
|
|
665
|
+
type: boolean
|
|
666
|
+
required: false # TODO hand rolled. W-9275477
|
|
667
|
+
validateProductCatalog:
|
|
668
|
+
description: Whether to run validations against the Product Catalog
|
|
669
|
+
type: boolean
|
|
670
|
+
required: false # TODO hand rolled. W-9275477
|
|
671
|
+
ConfiguratorOutputRepresentation:
|
|
672
|
+
description: Output Representation for the Configurator API
|
|
673
|
+
type: object
|
|
674
|
+
properties:
|
|
675
|
+
catalogProducts:
|
|
676
|
+
description: Product Data
|
|
677
|
+
type: array
|
|
678
|
+
required: false # TODO hand rolled. W-9275477
|
|
679
|
+
items:
|
|
680
|
+
type: ConfiguratorProductCatalogOutputRepresentation
|
|
681
|
+
errors:
|
|
682
|
+
description: List of Errors
|
|
683
|
+
type: array
|
|
684
|
+
required: false # TODO hand rolled. W-9275477
|
|
685
|
+
items:
|
|
686
|
+
type: object
|
|
687
|
+
messages:
|
|
688
|
+
description: Messages
|
|
689
|
+
type: any
|
|
690
|
+
required: false # TODO hand rolled. W-9275477
|
|
691
|
+
uiTreatments:
|
|
692
|
+
description: UI Treatments
|
|
693
|
+
type: array
|
|
694
|
+
required: false # TODO hand rolled. W-9275477
|
|
695
|
+
items:
|
|
696
|
+
type: object
|
|
697
|
+
success:
|
|
698
|
+
description: Success Flag
|
|
699
|
+
type: boolean
|
|
700
|
+
required: false # TODO hand rolled. W-9275477
|
|
701
|
+
transactionContext:
|
|
702
|
+
description: Transaction Context
|
|
703
|
+
type: any # TODO hand rolled. W-9320402
|
|
704
|
+
required: false # TODO hand rolled. W-9275477
|
|
705
|
+
transactionContextId:
|
|
706
|
+
description: Transaction Context ID
|
|
707
|
+
type: string
|
|
708
|
+
transactionContextMappingId:
|
|
709
|
+
description: Transaction Context Mapping ID
|
|
710
|
+
type: string
|
|
711
|
+
required: false # TODO hand rolled. W-9275477
|
|
712
|
+
transactionQualification:
|
|
713
|
+
description: Transaction Qualification Result
|
|
714
|
+
type: any # TODO hand rolled. W-9320402
|
|
715
|
+
required: false # TODO hand rolled. W-9275477
|
|
716
|
+
ConfiguratorPriceOutputRepresentation:
|
|
717
|
+
description: Output Representation for the Configurator API's Prices
|
|
718
|
+
type: object
|
|
719
|
+
properties:
|
|
720
|
+
currencyIsoCode:
|
|
721
|
+
description: Currency ISO Code
|
|
722
|
+
type: string
|
|
723
|
+
required: false # TODO hand rolled. W-9275477
|
|
724
|
+
effectiveFrom:
|
|
725
|
+
description: Effective From
|
|
726
|
+
type: string
|
|
727
|
+
required: false # TODO hand rolled. W-9275477
|
|
728
|
+
effectiveTo:
|
|
729
|
+
description: Effective To
|
|
730
|
+
type: string
|
|
731
|
+
required: false # TODO hand rolled. W-9275477
|
|
732
|
+
pricebookEntryId:
|
|
733
|
+
description: Pricebook Entry ID
|
|
734
|
+
type: string
|
|
735
|
+
required: false # TODO hand rolled. W-9275477
|
|
736
|
+
pricebookId:
|
|
737
|
+
description: Pricebook ID
|
|
738
|
+
type: string
|
|
739
|
+
required: false # TODO hand rolled. W-9275477
|
|
740
|
+
pricingModel:
|
|
741
|
+
description: Pricing Model
|
|
742
|
+
type: ConfiguratorPricingModelOutputRepresentation
|
|
743
|
+
required: false # TODO hand rolled. W-9275477
|
|
744
|
+
unitPrice:
|
|
745
|
+
description: Unit Price
|
|
746
|
+
format: double
|
|
747
|
+
type: number
|
|
748
|
+
required: false # TODO hand rolled. W-9275477
|
|
749
|
+
isDefault:
|
|
750
|
+
description: Default Pricing Model
|
|
751
|
+
type: boolean
|
|
752
|
+
required: false # TODO hand rolled. W-9275477
|
|
753
|
+
isSelected:
|
|
754
|
+
description: Selected Pricing Model
|
|
755
|
+
type: boolean
|
|
756
|
+
required: false # TODO hand rolled. W-9275477
|
|
757
|
+
isDerived:
|
|
758
|
+
description: Is Price Derived
|
|
759
|
+
type: boolean
|
|
760
|
+
required: false # TODO hand rolled. W-9275477
|
|
761
|
+
ConfiguratorPricingModelOutputRepresentation:
|
|
762
|
+
description: Output Representation for the Configurator API's Pricing Model
|
|
763
|
+
type: object
|
|
764
|
+
properties:
|
|
765
|
+
frequency:
|
|
766
|
+
description: Frequency
|
|
767
|
+
type: string
|
|
768
|
+
required: false # TODO hand rolled. W-9275477
|
|
769
|
+
id:
|
|
770
|
+
description: Pricing Model ID
|
|
771
|
+
type: string
|
|
772
|
+
required: false # TODO hand rolled. W-9275477
|
|
773
|
+
name:
|
|
774
|
+
description: Name
|
|
775
|
+
type: string
|
|
776
|
+
required: false # TODO hand rolled. W-9275477
|
|
777
|
+
occurrence:
|
|
778
|
+
description: Occurrence
|
|
779
|
+
type: integer
|
|
780
|
+
required: false # TODO hand rolled. W-9275477
|
|
781
|
+
pricingModelType:
|
|
782
|
+
description: Pricing Model Type
|
|
783
|
+
type: string
|
|
784
|
+
required: false # TODO hand rolled. W-9275477
|
|
785
|
+
unitOfMeasure:
|
|
786
|
+
description: Unit of Measure
|
|
787
|
+
type: string
|
|
788
|
+
required: false # TODO hand rolled. W-9275477
|
|
789
|
+
ConfiguratorProductCatalogOutputRepresentation:
|
|
790
|
+
description: Output Representation for the Configurator API's Enterprise Product
|
|
791
|
+
Catalog
|
|
792
|
+
type: object
|
|
793
|
+
properties:
|
|
794
|
+
additionalFields:
|
|
795
|
+
description: Additional Fields
|
|
796
|
+
type: array
|
|
797
|
+
required: false # TODO hand rolled. W-9275477
|
|
798
|
+
items:
|
|
799
|
+
type: ConfiguratorAdditionalFieldsOutputRepresentation
|
|
800
|
+
attributeCategories:
|
|
801
|
+
description: List of Attribute Categories
|
|
802
|
+
type: array
|
|
803
|
+
required: false # TODO hand rolled. W-9275477
|
|
804
|
+
items:
|
|
805
|
+
type: ConfiguratorAttributeCategoryOutputRepresentation
|
|
806
|
+
availabilityDate:
|
|
807
|
+
description: Availability Date
|
|
808
|
+
type: string
|
|
809
|
+
required: false # TODO hand rolled. W-9275477
|
|
810
|
+
description:
|
|
811
|
+
description: Product Description
|
|
812
|
+
type: string
|
|
813
|
+
required: false # TODO hand rolled. W-9275477
|
|
814
|
+
discontinuedDate:
|
|
815
|
+
description: Discontinued Date
|
|
816
|
+
type: string
|
|
817
|
+
required: false # TODO hand rolled. W-9275477
|
|
818
|
+
displayUrl:
|
|
819
|
+
description: Display URL
|
|
820
|
+
type: string
|
|
821
|
+
required: false # TODO hand rolled. W-9275477
|
|
822
|
+
endOfLifeDate:
|
|
823
|
+
description: End of Life Date
|
|
824
|
+
type: string
|
|
825
|
+
required: false # TODO hand rolled. W-9275477
|
|
826
|
+
id:
|
|
827
|
+
description: Product ID
|
|
828
|
+
type: string
|
|
829
|
+
required: false # TODO hand rolled. W-9275477
|
|
830
|
+
isActive:
|
|
831
|
+
description: Is this Product Active
|
|
832
|
+
type: boolean
|
|
833
|
+
required: false # TODO hand rolled. W-9275477
|
|
834
|
+
isAssetizable:
|
|
835
|
+
description: Is this Product Assetizable
|
|
836
|
+
type: boolean
|
|
837
|
+
required: false # TODO hand rolled. W-9275477
|
|
838
|
+
isComponentRequired:
|
|
839
|
+
description: Is Component Required
|
|
840
|
+
type: boolean
|
|
841
|
+
required: false # TODO hand rolled. W-9275477
|
|
842
|
+
isConfigurable:
|
|
843
|
+
description: Is Configurable
|
|
844
|
+
type: boolean
|
|
845
|
+
required: false # TODO hand rolled. W-9275477
|
|
846
|
+
isDefaultComponent:
|
|
847
|
+
description: Is Default Component
|
|
848
|
+
type: boolean
|
|
849
|
+
required: false # TODO hand rolled. W-9275477
|
|
850
|
+
isQuantityEditable:
|
|
851
|
+
description: Is Quantity Editable
|
|
852
|
+
type: boolean
|
|
853
|
+
required: false # TODO hand rolled. W-9275477
|
|
854
|
+
isSoldOnlyWithOtherProds:
|
|
855
|
+
description: Is this Product Sold Only with Other Products
|
|
856
|
+
type: boolean
|
|
857
|
+
required: false # TODO hand rolled. W-9275477
|
|
858
|
+
name:
|
|
859
|
+
description: Product Name
|
|
860
|
+
type: string
|
|
861
|
+
required: false # TODO hand rolled. W-9275477
|
|
862
|
+
nodeType:
|
|
863
|
+
description: Node Type
|
|
864
|
+
type: string
|
|
865
|
+
required: false # TODO hand rolled. W-9275477
|
|
866
|
+
prices:
|
|
867
|
+
description: List of Prices
|
|
868
|
+
type: array
|
|
869
|
+
required: false # TODO hand rolled. W-9275477
|
|
870
|
+
items:
|
|
871
|
+
type: ConfiguratorPriceOutputRepresentation
|
|
872
|
+
productClassification:
|
|
873
|
+
description: Product Classification
|
|
874
|
+
type: ConfiguratorProductClassificationOutputRepresentation
|
|
875
|
+
required: false # TODO hand rolled. W-9275477
|
|
876
|
+
productCode:
|
|
877
|
+
description: Product Code
|
|
878
|
+
type: string
|
|
879
|
+
required: false # TODO hand rolled. W-9275477
|
|
880
|
+
productComponentGroups:
|
|
881
|
+
description: Set of Product Component Groups
|
|
882
|
+
type: array
|
|
883
|
+
required: false # TODO hand rolled. W-9275477
|
|
884
|
+
items:
|
|
885
|
+
type: ConfiguratorProductComponentGroupOutputRepresentation
|
|
886
|
+
productRelatedComponent:
|
|
887
|
+
description: Product Related Component
|
|
888
|
+
type: ConfiguratorProductRelatedComponentOutputRepresentation
|
|
889
|
+
required: false # TODO hand rolled. W-9275477
|
|
890
|
+
productSellingModelOptions:
|
|
891
|
+
description: List of Product Selling Model Options
|
|
892
|
+
type: array
|
|
893
|
+
required: false # TODO hand rolled. W-9275477
|
|
894
|
+
items:
|
|
895
|
+
type: ConfiguratorProductSellingModelOptionOutputRepresentation
|
|
896
|
+
productType:
|
|
897
|
+
description: Product Type
|
|
898
|
+
type: string
|
|
899
|
+
required: false # TODO hand rolled. W-9275477
|
|
900
|
+
qualificationContext:
|
|
901
|
+
description: Qualification Context
|
|
902
|
+
type: ConfiguratorQualificationContextOutputRepresentation
|
|
903
|
+
required: false # TODO hand rolled. W-9275477
|
|
904
|
+
status:
|
|
905
|
+
description: Product Status
|
|
906
|
+
type: string
|
|
907
|
+
required: false # TODO hand rolled. W-9275477
|
|
908
|
+
productUsageModelType:
|
|
909
|
+
description: Product Usage Model Type
|
|
910
|
+
type: string
|
|
911
|
+
required: false # TODO hand rolled. W-9275477
|
|
912
|
+
unitOfMeasure:
|
|
913
|
+
description: UnitOfMeasure
|
|
914
|
+
type: ConfiguratorUnitOfMeasureOutputRepresentation
|
|
915
|
+
required: false # TODO hand rolled. W-9275477
|
|
916
|
+
ConfiguratorProductClassificationOutputRepresentation:
|
|
917
|
+
description: Output Representation for the Configurator API's Product Classification
|
|
918
|
+
type: object
|
|
919
|
+
properties:
|
|
920
|
+
id:
|
|
921
|
+
description: Product Classification ID
|
|
922
|
+
type: string
|
|
923
|
+
required: false # TODO hand rolled. W-9275477
|
|
924
|
+
ConfiguratorProductComponentGroupOutputRepresentation:
|
|
925
|
+
description: Output Representation for the Configurator API's Product Component
|
|
926
|
+
Group
|
|
927
|
+
type: object
|
|
928
|
+
properties:
|
|
929
|
+
classifications:
|
|
930
|
+
description: List of Product Classifications
|
|
931
|
+
type: array
|
|
932
|
+
required: false # TODO hand rolled. W-9275477
|
|
933
|
+
items:
|
|
934
|
+
type: ConfiguratorProductClassificationOutputRepresentation
|
|
935
|
+
code:
|
|
936
|
+
description: Code
|
|
937
|
+
type: string
|
|
938
|
+
required: false # TODO hand rolled. W-9275477
|
|
939
|
+
components:
|
|
940
|
+
description: Components
|
|
941
|
+
type: array
|
|
942
|
+
required: false # TODO hand rolled. W-9275477
|
|
943
|
+
items:
|
|
944
|
+
type: ConfiguratorProductCatalogOutputRepresentation
|
|
945
|
+
description:
|
|
946
|
+
description: Description
|
|
947
|
+
type: string
|
|
948
|
+
required: false # TODO hand rolled. W-9275477
|
|
949
|
+
id:
|
|
950
|
+
description: Product Component Group ID
|
|
951
|
+
type: string
|
|
952
|
+
required: false # TODO hand rolled. W-9275477
|
|
953
|
+
maxBundleComponents:
|
|
954
|
+
description: Max Bundle Components
|
|
955
|
+
type: integer
|
|
956
|
+
required: false # TODO hand rolled. W-9275477
|
|
957
|
+
minBundleComponents:
|
|
958
|
+
description: Min Bundle Components
|
|
959
|
+
type: integer
|
|
960
|
+
required: false # TODO hand rolled. W-9275477
|
|
961
|
+
name:
|
|
962
|
+
description: Name
|
|
963
|
+
type: string
|
|
964
|
+
required: false # TODO hand rolled. W-9275477
|
|
965
|
+
parentProductId:
|
|
966
|
+
description: Parent Product ID
|
|
967
|
+
type: string
|
|
968
|
+
required: false # TODO hand rolled. W-9275477
|
|
969
|
+
sequence:
|
|
970
|
+
description: Sequence
|
|
971
|
+
type: integer
|
|
972
|
+
required: false # TODO hand rolled. W-9275477
|
|
973
|
+
childGroups:
|
|
974
|
+
description: Child Groups
|
|
975
|
+
type: array
|
|
976
|
+
required: false # TODO hand rolled. W-9275477
|
|
977
|
+
items:
|
|
978
|
+
type: ConfiguratorProductComponentGroupOutputRepresentation
|
|
979
|
+
parentGroupId:
|
|
980
|
+
description: Parent Group ID
|
|
981
|
+
type: string
|
|
982
|
+
required: false # TODO hand rolled. W-9275477
|
|
983
|
+
ConfiguratorProductRelatedComponentOutputRepresentation:
|
|
984
|
+
description: Output Representation for the Configurator API's Product Related
|
|
985
|
+
Component
|
|
986
|
+
type: object
|
|
987
|
+
properties:
|
|
988
|
+
childProductId:
|
|
989
|
+
description: Child Product ID
|
|
990
|
+
type: string
|
|
991
|
+
required: false # TODO hand rolled. W-9275477
|
|
992
|
+
childSellingModelId:
|
|
993
|
+
description: Child PSM Id
|
|
994
|
+
type: string
|
|
995
|
+
required: false # TODO hand rolled. W-9275477
|
|
996
|
+
doesBundlePriceIncludeChild:
|
|
997
|
+
description: Does the bundle price include child products
|
|
998
|
+
type: boolean
|
|
999
|
+
required: false # TODO hand rolled. W-9275477
|
|
1000
|
+
id:
|
|
1001
|
+
description: ID of this Product Related Component
|
|
1002
|
+
type: string
|
|
1003
|
+
required: false # TODO hand rolled. W-9275477
|
|
1004
|
+
isComponentRequired:
|
|
1005
|
+
description: Is Component Required
|
|
1006
|
+
type: boolean
|
|
1007
|
+
required: false # TODO hand rolled. W-9275477
|
|
1008
|
+
isDefaultComponent:
|
|
1009
|
+
description: Is Default Component
|
|
1010
|
+
type: boolean
|
|
1011
|
+
required: false # TODO hand rolled. W-9275477
|
|
1012
|
+
isQuantityEditable:
|
|
1013
|
+
description: Is Quantity Editable
|
|
1014
|
+
type: boolean
|
|
1015
|
+
required: false # TODO hand rolled. W-9275477
|
|
1016
|
+
maxQuantity:
|
|
1017
|
+
description: Max Quantity
|
|
1018
|
+
format: double
|
|
1019
|
+
type: number
|
|
1020
|
+
required: false # TODO hand rolled. W-9275477
|
|
1021
|
+
minQuantity:
|
|
1022
|
+
description: Min Quantity
|
|
1023
|
+
format: double
|
|
1024
|
+
type: number
|
|
1025
|
+
required: false # TODO hand rolled. W-9275477
|
|
1026
|
+
parentProductId:
|
|
1027
|
+
description: Parent Product ID
|
|
1028
|
+
type: string
|
|
1029
|
+
required: false # TODO hand rolled. W-9275477
|
|
1030
|
+
parentSellingModelId:
|
|
1031
|
+
description: Parent PSM Id
|
|
1032
|
+
type: string
|
|
1033
|
+
required: false # TODO hand rolled. W-9275477
|
|
1034
|
+
productClassificationId:
|
|
1035
|
+
description: Product Classification ID
|
|
1036
|
+
type: string
|
|
1037
|
+
required: false # TODO hand rolled. W-9275477
|
|
1038
|
+
productComponentGroupId:
|
|
1039
|
+
description: Product Component Group ID
|
|
1040
|
+
type: string
|
|
1041
|
+
required: false # TODO hand rolled. W-9275477
|
|
1042
|
+
productRelationshipTypeId:
|
|
1043
|
+
description: PRT Id
|
|
1044
|
+
type: string
|
|
1045
|
+
required: false # TODO hand rolled. W-9275477
|
|
1046
|
+
quantity:
|
|
1047
|
+
description: Default Quantity
|
|
1048
|
+
format: double
|
|
1049
|
+
type: number
|
|
1050
|
+
required: false # TODO hand rolled. W-9275477
|
|
1051
|
+
quantityScaleMethod:
|
|
1052
|
+
description: Quantity Scale Method
|
|
1053
|
+
type: string
|
|
1054
|
+
required: false # TODO hand rolled. W-9275477
|
|
1055
|
+
enum:
|
|
1056
|
+
- Constant
|
|
1057
|
+
- Proportional
|
|
1058
|
+
sequence:
|
|
1059
|
+
description: Sequence
|
|
1060
|
+
type: integer
|
|
1061
|
+
required: false # TODO hand rolled. W-9275477
|
|
1062
|
+
unitOfMeasure:
|
|
1063
|
+
description: UnitOfMeasure
|
|
1064
|
+
type: ConfiguratorUnitOfMeasureOutputRepresentation
|
|
1065
|
+
required: false # TODO hand rolled. W-9275477
|
|
1066
|
+
ConfiguratorProductSellingModelOptionOutputRepresentation:
|
|
1067
|
+
description: Output Representation for the Configurator API's Product Selling
|
|
1068
|
+
Model Option
|
|
1069
|
+
type: object
|
|
1070
|
+
properties:
|
|
1071
|
+
id:
|
|
1072
|
+
description: PSMO ID
|
|
1073
|
+
type: string
|
|
1074
|
+
required: false # TODO hand rolled. W-9275477
|
|
1075
|
+
productId:
|
|
1076
|
+
description: Product ID
|
|
1077
|
+
type: string
|
|
1078
|
+
required: false # TODO hand rolled. W-9275477
|
|
1079
|
+
productSellingModel:
|
|
1080
|
+
description: Product Selling Model
|
|
1081
|
+
type: ConfiguratorProductSellingModelOutputRepresentation
|
|
1082
|
+
required: false # TODO hand rolled. W-9275477
|
|
1083
|
+
productSellingModelId:
|
|
1084
|
+
description: PSM ID
|
|
1085
|
+
type: string
|
|
1086
|
+
required: false # TODO hand rolled. W-9275477
|
|
1087
|
+
ConfiguratorProductSellingModelOutputRepresentation:
|
|
1088
|
+
description: Output Representation for the Configurator API's Product Selling
|
|
1089
|
+
Model
|
|
1090
|
+
type: object
|
|
1091
|
+
properties:
|
|
1092
|
+
id:
|
|
1093
|
+
description: PSM ID
|
|
1094
|
+
type: string
|
|
1095
|
+
required: false # TODO hand rolled. W-9275477
|
|
1096
|
+
name:
|
|
1097
|
+
description: PSM Name
|
|
1098
|
+
type: string
|
|
1099
|
+
required: false # TODO hand rolled. W-9275477
|
|
1100
|
+
pricingTerm:
|
|
1101
|
+
description: Pricing Term
|
|
1102
|
+
type: integer
|
|
1103
|
+
required: false # TODO hand rolled. W-9275477
|
|
1104
|
+
pricingTermUnit:
|
|
1105
|
+
description: Pricing Term Unit
|
|
1106
|
+
type: string
|
|
1107
|
+
required: false # TODO hand rolled. W-9275477
|
|
1108
|
+
sellingModelType:
|
|
1109
|
+
description: Selling Model Type
|
|
1110
|
+
type: string
|
|
1111
|
+
required: false # TODO hand rolled. W-9275477
|
|
1112
|
+
status:
|
|
1113
|
+
description: PSM Status
|
|
1114
|
+
type: string
|
|
1115
|
+
required: false # TODO hand rolled. W-9275477
|
|
1116
|
+
ConfiguratorQualificationContextOutputRepresentation:
|
|
1117
|
+
description: Output Representation for the Configurator API's Qualification Context
|
|
1118
|
+
type: object
|
|
1119
|
+
properties:
|
|
1120
|
+
isQualified:
|
|
1121
|
+
description: Is Qualified
|
|
1122
|
+
type: boolean
|
|
1123
|
+
required: false # TODO hand rolled. W-9275477
|
|
1124
|
+
reason:
|
|
1125
|
+
description: Reason
|
|
1126
|
+
type: string
|
|
1127
|
+
required: false # TODO hand rolled. W-9275477
|
|
1128
|
+
ConfiguratorQuantityInfoOutputRepresentation:
|
|
1129
|
+
description: Output Representation for the Configurator API's Quantity Info
|
|
1130
|
+
type: object
|
|
1131
|
+
properties:
|
|
1132
|
+
maxQuantity:
|
|
1133
|
+
description: Max Quanity
|
|
1134
|
+
format: double
|
|
1135
|
+
type: number
|
|
1136
|
+
required: false # TODO hand rolled. W-9275477
|
|
1137
|
+
minQuantity:
|
|
1138
|
+
description: Min Quantity
|
|
1139
|
+
format: double
|
|
1140
|
+
type: number
|
|
1141
|
+
required: false # TODO hand rolled. W-9275477
|
|
1142
|
+
quantity:
|
|
1143
|
+
description: Default Quantity
|
|
1144
|
+
format: double
|
|
1145
|
+
type: number
|
|
1146
|
+
required: false # TODO hand rolled. W-9275477
|
|
1147
|
+
quantityScaleMethod:
|
|
1148
|
+
description: Quantity Scale Method
|
|
1149
|
+
type: string
|
|
1150
|
+
required: false # TODO hand rolled. W-9275477
|
|
1151
|
+
enum:
|
|
1152
|
+
- Constant
|
|
1153
|
+
- Proportional
|
|
1154
|
+
ConfiguratorRuleInputRepresentation:
|
|
1155
|
+
description: Input Representation for configurator rules
|
|
1156
|
+
type: object
|
|
1157
|
+
properties:
|
|
1158
|
+
actions:
|
|
1159
|
+
description: Actions of the rule
|
|
1160
|
+
type: array
|
|
1161
|
+
items:
|
|
1162
|
+
type: any # TODO hand rolled. W-9320402
|
|
1163
|
+
apiName:
|
|
1164
|
+
description: API Name of the configurator rule
|
|
1165
|
+
type: string
|
|
1166
|
+
required: false # TODO hand rolled. W-9275477
|
|
1167
|
+
criteria:
|
|
1168
|
+
description: Main conditions/criteria of the rule
|
|
1169
|
+
type: array
|
|
1170
|
+
items:
|
|
1171
|
+
type: any # TODO hand rolled. W-9320402
|
|
1172
|
+
criteriaExpressionType:
|
|
1173
|
+
description: Conditional logic between the conditions
|
|
1174
|
+
type: string
|
|
1175
|
+
required: false # TODO hand rolled. W-9275477
|
|
1176
|
+
enum:
|
|
1177
|
+
- All
|
|
1178
|
+
description:
|
|
1179
|
+
description: Description of the rule
|
|
1180
|
+
type: string
|
|
1181
|
+
required: false # TODO hand rolled. W-9275477
|
|
1182
|
+
endDate:
|
|
1183
|
+
description: Rule in-effective after this date
|
|
1184
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1185
|
+
required: false # TODO hand rolled. W-9275477
|
|
1186
|
+
name:
|
|
1187
|
+
description: Name of the configurator rule
|
|
1188
|
+
type: string
|
|
1189
|
+
required: false # TODO hand rolled. W-9275477
|
|
1190
|
+
productConfigurationRuleId:
|
|
1191
|
+
description: Product Configuration Rule Id for update.
|
|
1192
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1193
|
+
required: false # TODO hand rolled. W-9275477
|
|
1194
|
+
scope:
|
|
1195
|
+
description: Rule scope
|
|
1196
|
+
type: string
|
|
1197
|
+
required: false # TODO hand rolled. W-9275477
|
|
1198
|
+
enum:
|
|
1199
|
+
- Bundle
|
|
1200
|
+
- Product
|
|
1201
|
+
- Transaction
|
|
1202
|
+
sequence:
|
|
1203
|
+
description: Sequence for the rule
|
|
1204
|
+
type: integer
|
|
1205
|
+
required: false # TODO hand rolled. W-9275477
|
|
1206
|
+
startDate:
|
|
1207
|
+
description: Rule effective from this date
|
|
1208
|
+
type: string
|
|
1209
|
+
required: false # TODO hand rolled. W-9275477
|
|
1210
|
+
status:
|
|
1211
|
+
description: Status of the rule
|
|
1212
|
+
type: string
|
|
1213
|
+
required: false # TODO hand rolled. W-9275477
|
|
1214
|
+
enum:
|
|
1215
|
+
- Active
|
|
1216
|
+
- Draft
|
|
1217
|
+
- Inactive
|
|
1218
|
+
usageSubType:
|
|
1219
|
+
description: Usage sub type for the rule
|
|
1220
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1221
|
+
required: false # TODO hand rolled. W-9275477
|
|
1222
|
+
ConfiguratorRuleOutputRepresentation:
|
|
1223
|
+
description: Output Representation for Config Rules
|
|
1224
|
+
type: object
|
|
1225
|
+
properties:
|
|
1226
|
+
errors:
|
|
1227
|
+
description: List of Errors
|
|
1228
|
+
type: array
|
|
1229
|
+
required: false # TODO hand rolled. W-9275477
|
|
1230
|
+
items:
|
|
1231
|
+
type: object
|
|
1232
|
+
productConfigurationRuleId:
|
|
1233
|
+
description: Product Configuration Rule entity id
|
|
1234
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
1235
|
+
required: false # TODO hand rolled. W-9275477
|
|
1236
|
+
success:
|
|
1237
|
+
description: Rule creation Success / Failure
|
|
1238
|
+
type: boolean
|
|
1239
|
+
ConfiguratorRuleValidatorInputRepresentation:
|
|
1240
|
+
description: Input Representation for rule validator
|
|
1241
|
+
type: object
|
|
1242
|
+
properties:
|
|
1243
|
+
productConfigurationRuleId:
|
|
1244
|
+
description: Id of the product configuration rule
|
|
1245
|
+
type: string
|
|
1246
|
+
ConfiguratorRuleValidatorOutputRepresentation:
|
|
1247
|
+
description: Output Representation for Config Rule Validator
|
|
1248
|
+
type: object
|
|
1249
|
+
properties:
|
|
1250
|
+
isValid:
|
|
1251
|
+
description: Rule validation Success / Failure
|
|
1252
|
+
type: boolean
|
|
1253
|
+
validationMessages:
|
|
1254
|
+
description: List of Errors
|
|
1255
|
+
type: array
|
|
1256
|
+
items:
|
|
1257
|
+
type: string
|
|
1258
|
+
ConfiguratorUnitOfMeasureOutputRepresentation:
|
|
1259
|
+
description: Output Representation for the Configurator API's UnitOfMeasure
|
|
1260
|
+
type: object
|
|
1261
|
+
properties:
|
|
1262
|
+
id:
|
|
1263
|
+
description: Id of unitOfMeasure
|
|
1264
|
+
type: string
|
|
1265
|
+
required: false # TODO hand rolled. W-9275477
|
|
1266
|
+
name:
|
|
1267
|
+
description: Name of unitOfMeasure
|
|
1268
|
+
type: string
|
|
1269
|
+
required: false # TODO hand rolled. W-9275477
|
|
1270
|
+
roundingMethod:
|
|
1271
|
+
description: RoundingMethod of unitOfMeasure
|
|
1272
|
+
type: string
|
|
1273
|
+
required: false # TODO hand rolled. W-9275477
|
|
1274
|
+
scale:
|
|
1275
|
+
description: Scale of unitOfMeasure
|
|
1276
|
+
type: integer
|
|
1277
|
+
required: false # TODO hand rolled. W-9275477
|
|
1278
|
+
unitCode:
|
|
1279
|
+
description: UnitCode of unitOfMeasure
|
|
1280
|
+
type: string
|
|
1281
|
+
required: false # TODO hand rolled. W-9275477
|
|
1282
|
+
ConfiguratorUpdatedNodeInputRepresentation:
|
|
1283
|
+
description: Input Representation for Updated Nodes to the Configurator
|
|
1284
|
+
type: object
|
|
1285
|
+
properties:
|
|
1286
|
+
path:
|
|
1287
|
+
description: Path to the Updated Node
|
|
1288
|
+
type: array
|
|
1289
|
+
required: false # TODO hand rolled. W-9275477
|
|
1290
|
+
items:
|
|
1291
|
+
type: string
|
|
1292
|
+
updatedAttributes:
|
|
1293
|
+
description: Updated Node Details
|
|
1294
|
+
type: any # TODO hand rolled. W-9320402
|
|
1295
|
+
required: true # TODO hand rolled. W-9275477
|
|
1296
|
+
BulkProductDetailsInput:
|
|
1297
|
+
description: Input Representation for Bulk Product details.
|
|
1298
|
+
type: object
|
|
1299
|
+
properties:
|
|
1300
|
+
additionalFields:
|
|
1301
|
+
description: Map of additional fields
|
|
1302
|
+
type: object
|
|
1303
|
+
required: false
|
|
1304
|
+
catalogId:
|
|
1305
|
+
description: Id of the catalog.
|
|
1306
|
+
type: string
|
|
1307
|
+
correlationId:
|
|
1308
|
+
description: CorrelationId
|
|
1309
|
+
type: string
|
|
1310
|
+
required: false
|
|
1311
|
+
priceBookId:
|
|
1312
|
+
description: Id of the price Book.
|
|
1313
|
+
type: string
|
|
1314
|
+
productData:
|
|
1315
|
+
description: Individual Product Data
|
|
1316
|
+
type: array
|
|
1317
|
+
items:
|
|
1318
|
+
type: ProductDataInput
|
|
1319
|
+
userContext:
|
|
1320
|
+
description: User context
|
|
1321
|
+
type: object
|
|
1322
|
+
contextDefinition:
|
|
1323
|
+
description: Context Definition Name
|
|
1324
|
+
type: string
|
|
1325
|
+
required: false
|
|
1326
|
+
contextMapping:
|
|
1327
|
+
description: Context Mapping Name
|
|
1328
|
+
type: string
|
|
1329
|
+
required: false
|
|
1330
|
+
currencyCode:
|
|
1331
|
+
description: Currency code for the prices
|
|
1332
|
+
type: string
|
|
1333
|
+
required: false
|
|
1334
|
+
enablePricing:
|
|
1335
|
+
description: Enable Pricing
|
|
1336
|
+
type: boolean
|
|
1337
|
+
required: false
|
|
1338
|
+
enableQualification:
|
|
1339
|
+
description: Enable Qualification
|
|
1340
|
+
type: boolean
|
|
1341
|
+
required: false
|
|
1342
|
+
pricingProcedure:
|
|
1343
|
+
description: Pricing Procedure Name
|
|
1344
|
+
type: string
|
|
1345
|
+
required: false
|
|
1346
|
+
qualificationProcedure:
|
|
1347
|
+
description: Qualification Procedure Name
|
|
1348
|
+
type: string
|
|
1349
|
+
required: false
|
|
1350
|
+
ProductDataInput:
|
|
1351
|
+
description: Input Representation for Product specific Data
|
|
1352
|
+
type: object
|
|
1353
|
+
properties:
|
|
1354
|
+
productId:
|
|
1355
|
+
description: Id of the product
|
|
1356
|
+
type: string
|
|
1357
|
+
productSellingModelId:
|
|
1358
|
+
description: Id of the productSellingModel.
|
|
1359
|
+
type: string
|
|
1360
|
+
required: false
|
|
1361
|
+
FilterCriteriaInputRepresentation:
|
|
1362
|
+
description: Input Representation for Filter Criteria
|
|
1363
|
+
type: object
|
|
1364
|
+
properties:
|
|
1365
|
+
operator:
|
|
1366
|
+
description: operator
|
|
1367
|
+
type: string
|
|
1368
|
+
property:
|
|
1369
|
+
description: property
|
|
1370
|
+
type: string
|
|
1371
|
+
value:
|
|
1372
|
+
description: value
|
|
1373
|
+
type: any
|
|
1374
|
+
attributeType:
|
|
1375
|
+
description: attributeType
|
|
1376
|
+
type: string
|
|
1377
|
+
required: false
|
|
1378
|
+
FilterInputRepresentation:
|
|
1379
|
+
description: Input Representation for Filters
|
|
1380
|
+
type: object
|
|
1381
|
+
properties:
|
|
1382
|
+
criteria:
|
|
1383
|
+
description: filter criteria
|
|
1384
|
+
type: array
|
|
1385
|
+
items:
|
|
1386
|
+
type: FilterCriteriaInputRepresentation
|
|
1387
|
+
CpqBaseBulkDetailsOutput:
|
|
1388
|
+
description: Base representation for bulk details apis
|
|
1389
|
+
type: object
|
|
1390
|
+
properties:
|
|
1391
|
+
apiStatus:
|
|
1392
|
+
description: Api Status Object
|
|
1393
|
+
type: ApiStatusOutputRepresentation
|
|
1394
|
+
contextId:
|
|
1395
|
+
description: ContextId
|
|
1396
|
+
type: string
|
|
1397
|
+
required: false
|
|
1398
|
+
correlationId:
|
|
1399
|
+
description: CorrelationId
|
|
1400
|
+
type: string
|
|
1401
|
+
required: false
|
|
1402
|
+
result:
|
|
1403
|
+
description: Result object
|
|
1404
|
+
type: array
|
|
1405
|
+
items:
|
|
1406
|
+
type: object
|
|
1407
|
+
userContext:
|
|
1408
|
+
description: User Context
|
|
1409
|
+
type: object
|
|
1410
|
+
required: false
|
|
1411
|
+
CpqBaseDetailsOutputRepresentation:
|
|
1412
|
+
description: Base representation for details apis
|
|
1413
|
+
type: object
|
|
1414
|
+
properties:
|
|
1415
|
+
apiStatus:
|
|
1416
|
+
description: Api Status Object
|
|
1417
|
+
type: ApiStatusOutputRepresentation
|
|
1418
|
+
correlationId:
|
|
1419
|
+
description: CorrelationId
|
|
1420
|
+
type: string
|
|
1421
|
+
required: false
|
|
1422
|
+
result:
|
|
1423
|
+
description: Result object
|
|
1424
|
+
type: object
|
|
1425
|
+
CpqBaseListOutputRepresentation:
|
|
1426
|
+
description: Base representation for list apis
|
|
1427
|
+
type: object
|
|
1428
|
+
properties:
|
|
1429
|
+
apiStatus:
|
|
1430
|
+
description: Api Status Object
|
|
1431
|
+
type: ApiStatusOutputRepresentation
|
|
1432
|
+
correlationId:
|
|
1433
|
+
description: CorrelationId
|
|
1434
|
+
type: string
|
|
1435
|
+
required: false
|
|
1436
|
+
limit:
|
|
1437
|
+
description: Limit
|
|
1438
|
+
type: integer
|
|
1439
|
+
required: false
|
|
1440
|
+
offSet:
|
|
1441
|
+
description: Offset
|
|
1442
|
+
type: integer
|
|
1443
|
+
required: false
|
|
1444
|
+
query:
|
|
1445
|
+
description: Input Query Object
|
|
1446
|
+
type: any
|
|
1447
|
+
required: false
|
|
1448
|
+
result:
|
|
1449
|
+
description: Result object
|
|
1450
|
+
type: array
|
|
1451
|
+
items:
|
|
1452
|
+
type: object
|
|
1453
|
+
total:
|
|
1454
|
+
description: Totals
|
|
1455
|
+
type: integer
|
|
1456
|
+
required: false
|
|
1457
|
+
facets:
|
|
1458
|
+
description: Facets object
|
|
1459
|
+
type: array
|
|
1460
|
+
items:
|
|
1461
|
+
type: SearchProductsFacetRepresentation
|
|
1462
|
+
CpqMessageOutputRepresentation:
|
|
1463
|
+
description: Output representation for apis message
|
|
1464
|
+
type: object
|
|
1465
|
+
properties:
|
|
1466
|
+
code:
|
|
1467
|
+
description: Code specifying the type/cause of message
|
|
1468
|
+
type: string
|
|
1469
|
+
required: false
|
|
1470
|
+
detail:
|
|
1471
|
+
description: Message detail contains any info needed other than message text
|
|
1472
|
+
type: string
|
|
1473
|
+
required: false
|
|
1474
|
+
message:
|
|
1475
|
+
description: Message text
|
|
1476
|
+
type: string
|
|
1477
|
+
required: false
|
|
1478
|
+
severity:
|
|
1479
|
+
description: Message Severity
|
|
1480
|
+
type: string
|
|
1481
|
+
required: false
|
|
1482
|
+
CreateCartRequestWrapper:
|
|
1483
|
+
description: Wrapper for Create Cart API
|
|
1484
|
+
type: object
|
|
1485
|
+
properties:
|
|
1486
|
+
createCartRequestPayload:
|
|
1487
|
+
type: CreateCartInputRepresentation
|
|
1488
|
+
description: An Input Representation adding products to the existing cart
|
|
1489
|
+
CreateCartInputRepresentation:
|
|
1490
|
+
description: Input Representation for Create Cart.
|
|
1491
|
+
type: object
|
|
1492
|
+
properties:
|
|
1493
|
+
correlationId:
|
|
1494
|
+
description: CorrelationId
|
|
1495
|
+
type: string
|
|
1496
|
+
required: false
|
|
1497
|
+
customFields:
|
|
1498
|
+
description: Key value pair of custom fields
|
|
1499
|
+
type: object
|
|
1500
|
+
required: false
|
|
1501
|
+
properties:
|
|
1502
|
+
//:
|
|
1503
|
+
type: string
|
|
1504
|
+
productConfigurations:
|
|
1505
|
+
description: Cart Items to be added to cart
|
|
1506
|
+
required: false
|
|
1507
|
+
type: array
|
|
1508
|
+
items:
|
|
1509
|
+
type: object
|
|
1510
|
+
toBeUpdatedFields:
|
|
1511
|
+
description: Key value pair of cart header fields to be updated
|
|
1512
|
+
required: false
|
|
1513
|
+
type: object
|
|
1514
|
+
properties:
|
|
1515
|
+
//:
|
|
1516
|
+
type: object
|
|
1517
|
+
userContext:
|
|
1518
|
+
description: User context in which cart would be created
|
|
1519
|
+
required: false
|
|
1520
|
+
type: object
|
|
1521
|
+
CreateCartOutputRepresentation:
|
|
1522
|
+
description: Output Representation for Create Cart
|
|
1523
|
+
type: object
|
|
1524
|
+
properties:
|
|
1525
|
+
cartId:
|
|
1526
|
+
description: Cart Identifier
|
|
1527
|
+
required: false
|
|
1528
|
+
type: string
|
|
1529
|
+
apiStatus:
|
|
1530
|
+
description: API Status
|
|
1531
|
+
type: ApiStatusOutputRepresentation
|
|
1532
|
+
CreateFavoriteOutputRepresentation:
|
|
1533
|
+
description: Create Favorite Output Representation
|
|
1534
|
+
type: object
|
|
1535
|
+
properties:
|
|
1536
|
+
errors:
|
|
1537
|
+
description: List of Errors
|
|
1538
|
+
type: array
|
|
1539
|
+
items:
|
|
1540
|
+
type: object
|
|
1541
|
+
id:
|
|
1542
|
+
description: favorite id
|
|
1543
|
+
type: string
|
|
1544
|
+
CartItemOutputRepresentation:
|
|
1545
|
+
description: Output Representation for Cart Item
|
|
1546
|
+
type: object
|
|
1547
|
+
properties:
|
|
1548
|
+
attributeCategories:
|
|
1549
|
+
description: Map of attribute categories for this Cart Item
|
|
1550
|
+
required: false
|
|
1551
|
+
type: array
|
|
1552
|
+
items:
|
|
1553
|
+
type: AttributeCategoryOutputRepresentation
|
|
1554
|
+
attributes:
|
|
1555
|
+
description: List of non-categorized attributes for given cart Item
|
|
1556
|
+
required: false
|
|
1557
|
+
type: array
|
|
1558
|
+
items:
|
|
1559
|
+
type: ProductAttributeOutputRepresentation
|
|
1560
|
+
cartItemId:
|
|
1561
|
+
description: Unique Id for Cart Item
|
|
1562
|
+
required: false
|
|
1563
|
+
type: string
|
|
1564
|
+
displayName:
|
|
1565
|
+
description: Display Name of Cart Item
|
|
1566
|
+
required: false
|
|
1567
|
+
type: string
|
|
1568
|
+
name:
|
|
1569
|
+
description: Name of the Cart Item
|
|
1570
|
+
required: false
|
|
1571
|
+
type: string
|
|
1572
|
+
netUnitPrice:
|
|
1573
|
+
description: Net unit Price for this Cart Item
|
|
1574
|
+
format: double
|
|
1575
|
+
required: false
|
|
1576
|
+
type: number
|
|
1577
|
+
priceWaterFall:
|
|
1578
|
+
description: Price Water Fall for this Cart Item
|
|
1579
|
+
required: false
|
|
1580
|
+
type: string
|
|
1581
|
+
productCode:
|
|
1582
|
+
description: Product Code of product added to Cart
|
|
1583
|
+
required: false
|
|
1584
|
+
type: string
|
|
1585
|
+
productId:
|
|
1586
|
+
description: Product Id of product added to Cart
|
|
1587
|
+
required: false
|
|
1588
|
+
type: string
|
|
1589
|
+
quantity:
|
|
1590
|
+
description: Quantity of product added to Cart
|
|
1591
|
+
format: double
|
|
1592
|
+
required: false
|
|
1593
|
+
type: number
|
|
1594
|
+
unitPrice:
|
|
1595
|
+
description: Unit price for this Cart Item
|
|
1596
|
+
format: double
|
|
1597
|
+
required: false
|
|
1598
|
+
type: number
|
|
1599
|
+
CartItemsOutputRepresentation:
|
|
1600
|
+
description: Output Representation for CartItems
|
|
1601
|
+
type: object
|
|
1602
|
+
properties:
|
|
1603
|
+
records:
|
|
1604
|
+
description: List of cart items available in cart
|
|
1605
|
+
type: array
|
|
1606
|
+
required: false
|
|
1607
|
+
items:
|
|
1608
|
+
type: CartItemOutputRepresentation
|
|
1609
|
+
totalSize:
|
|
1610
|
+
description: Count of cart items available in cart
|
|
1611
|
+
required: false
|
|
1612
|
+
type: integer
|
|
1613
|
+
CreateCartItemsOutputRepresentation:
|
|
1614
|
+
description: Output representation for the Connect API - CreateCartItems (Add
|
|
1615
|
+
to Cart) API.
|
|
1616
|
+
type: object
|
|
1617
|
+
properties:
|
|
1618
|
+
apiStatus:
|
|
1619
|
+
description: API Status
|
|
1620
|
+
type: ApiStatusOutputRepresentation
|
|
1621
|
+
cartId:
|
|
1622
|
+
description: Cart Identifier
|
|
1623
|
+
required: false
|
|
1624
|
+
type: string
|
|
1625
|
+
CreateCartItemsInputRepresentationWrapper:
|
|
1626
|
+
description: Create Cart Items Input Representation Wrapper
|
|
1627
|
+
type: object
|
|
1628
|
+
properties:
|
|
1629
|
+
requestBody:
|
|
1630
|
+
description: Key for api call
|
|
1631
|
+
type: CreateCartItemsInputRepresentation
|
|
1632
|
+
CreateCartItemsInputRepresentation:
|
|
1633
|
+
description: Input representation for the Connect API - CreateCartItems (Add to
|
|
1634
|
+
Cart) API.
|
|
1635
|
+
type: object
|
|
1636
|
+
properties:
|
|
1637
|
+
correlationId:
|
|
1638
|
+
description: CorrelationId
|
|
1639
|
+
required: false
|
|
1640
|
+
type: string
|
|
1641
|
+
productConfigurations:
|
|
1642
|
+
description: Products (with or without configuration) to be added to the cart.
|
|
1643
|
+
type: array
|
|
1644
|
+
required: false
|
|
1645
|
+
items:
|
|
1646
|
+
type: object
|
|
1647
|
+
userContext:
|
|
1648
|
+
description: User context in which cart would be modified
|
|
1649
|
+
required: false
|
|
1650
|
+
type: object
|
|
1651
|
+
PricingTotalOutputRepresentation:
|
|
1652
|
+
description: Pricing total output representation
|
|
1653
|
+
type: object
|
|
1654
|
+
properties:
|
|
1655
|
+
amount:
|
|
1656
|
+
description: Cart total for the price type
|
|
1657
|
+
format: double
|
|
1658
|
+
required: false
|
|
1659
|
+
type: number
|
|
1660
|
+
frequency:
|
|
1661
|
+
description: Frequency for the cart total
|
|
1662
|
+
required: false
|
|
1663
|
+
type: string
|
|
1664
|
+
occurrence:
|
|
1665
|
+
description: Occurence for the price type
|
|
1666
|
+
required: false
|
|
1667
|
+
type: integer
|
|
1668
|
+
priceType:
|
|
1669
|
+
description: Price Type
|
|
1670
|
+
required: false
|
|
1671
|
+
type: string
|
|
1672
|
+
CartPricingTotalOutputRepresentation:
|
|
1673
|
+
description: Cart Pricing total output representation
|
|
1674
|
+
type: object
|
|
1675
|
+
properties:
|
|
1676
|
+
apiStatus:
|
|
1677
|
+
description: API Status
|
|
1678
|
+
type: ApiStatusOutputRepresentation
|
|
1679
|
+
cartId:
|
|
1680
|
+
description: Id of the cart for which pricing was run
|
|
1681
|
+
required: false
|
|
1682
|
+
type: string
|
|
1683
|
+
cartPricingTotals:
|
|
1684
|
+
description: List of price totals of different types in cart
|
|
1685
|
+
required: false
|
|
1686
|
+
type: array
|
|
1687
|
+
items:
|
|
1688
|
+
type: PricingTotalOutputRepresentation
|
|
1689
|
+
GetCartOutputRepresentation:
|
|
1690
|
+
description: Output Representation for Get Cart
|
|
1691
|
+
type: object
|
|
1692
|
+
properties:
|
|
1693
|
+
apiStatus:
|
|
1694
|
+
description: API Status
|
|
1695
|
+
type: ApiStatusOutputRepresentation
|
|
1696
|
+
cartId:
|
|
1697
|
+
description: Unique identifier(id) of the cart
|
|
1698
|
+
required: false
|
|
1699
|
+
type: string
|
|
1700
|
+
cartItems:
|
|
1701
|
+
description: 'Cart Items '
|
|
1702
|
+
required: false
|
|
1703
|
+
type: CartItemsOutputRepresentation
|
|
1704
|
+
totals:
|
|
1705
|
+
description: Cart Total Pricing details
|
|
1706
|
+
required: false
|
|
1707
|
+
type: array
|
|
1708
|
+
items:
|
|
1709
|
+
type: PricingTotalOutputRepresentation
|
|
1710
|
+
GuidedSelectionSearchTermInputRepresentation:
|
|
1711
|
+
description: Input Representation for Guided Selection Search Term.
|
|
1712
|
+
type: object
|
|
1713
|
+
properties:
|
|
1714
|
+
tags:
|
|
1715
|
+
description: Guided Selection Tags
|
|
1716
|
+
type: array
|
|
1717
|
+
required: false
|
|
1718
|
+
items:
|
|
1719
|
+
type: string
|
|
1720
|
+
term:
|
|
1721
|
+
description: Guided Selection Search Term
|
|
1722
|
+
required: false
|
|
1723
|
+
type: string
|
|
1724
|
+
GuidedSelectionInputRepresentation:
|
|
1725
|
+
description: Input Representation for Guided Selection.
|
|
1726
|
+
type: object
|
|
1727
|
+
properties:
|
|
1728
|
+
additionalContextData:
|
|
1729
|
+
description: Additional Context Data
|
|
1730
|
+
type: any
|
|
1731
|
+
required: false
|
|
1732
|
+
additionalFields:
|
|
1733
|
+
description: Map of additional fields
|
|
1734
|
+
type: object
|
|
1735
|
+
required: false
|
|
1736
|
+
catalogId:
|
|
1737
|
+
description: Id of the catalog.
|
|
1738
|
+
type: string
|
|
1739
|
+
required: false
|
|
1740
|
+
categoryId:
|
|
1741
|
+
description: Id of the category.
|
|
1742
|
+
type: string
|
|
1743
|
+
required: false
|
|
1744
|
+
contextDefinition:
|
|
1745
|
+
description: Context Definition Name
|
|
1746
|
+
type: string
|
|
1747
|
+
required: false
|
|
1748
|
+
contextMapping:
|
|
1749
|
+
description: Context Mapping Name
|
|
1750
|
+
type: string
|
|
1751
|
+
required: false
|
|
1752
|
+
correlationId:
|
|
1753
|
+
description: CorrelationId
|
|
1754
|
+
type: string
|
|
1755
|
+
required: false
|
|
1756
|
+
currencyCode:
|
|
1757
|
+
description: Currency code for the prices
|
|
1758
|
+
type: string
|
|
1759
|
+
required: false
|
|
1760
|
+
cursor:
|
|
1761
|
+
description: Cursor
|
|
1762
|
+
type: string
|
|
1763
|
+
required: false
|
|
1764
|
+
enablePricing:
|
|
1765
|
+
description: Enable Pricing
|
|
1766
|
+
type: boolean
|
|
1767
|
+
required: false
|
|
1768
|
+
enableQualification:
|
|
1769
|
+
description: Enable Qualification
|
|
1770
|
+
type: boolean
|
|
1771
|
+
required: false
|
|
1772
|
+
usePromotions:
|
|
1773
|
+
description: Enable Promotion Rules
|
|
1774
|
+
type: boolean
|
|
1775
|
+
required: false
|
|
1776
|
+
filter:
|
|
1777
|
+
description: Filters
|
|
1778
|
+
type: FilterInputRepresentation
|
|
1779
|
+
required: false
|
|
1780
|
+
includeCatalogDetails:
|
|
1781
|
+
description: Get Catalog details
|
|
1782
|
+
type: boolean
|
|
1783
|
+
required: false
|
|
1784
|
+
limit:
|
|
1785
|
+
description: Number of item count you want in the response
|
|
1786
|
+
type: integer
|
|
1787
|
+
required: false
|
|
1788
|
+
offset:
|
|
1789
|
+
description: Offset size from which you need the catalog count
|
|
1790
|
+
type: integer
|
|
1791
|
+
required: false
|
|
1792
|
+
orderBy:
|
|
1793
|
+
description: Sort by ascending/descending order
|
|
1794
|
+
type: array
|
|
1795
|
+
required: false
|
|
1796
|
+
items:
|
|
1797
|
+
type: string
|
|
1798
|
+
priceBookId:
|
|
1799
|
+
description: Id of the price Book.
|
|
1800
|
+
type: string
|
|
1801
|
+
required: false
|
|
1802
|
+
pricingProcedure:
|
|
1803
|
+
description: Pricing Procedure Name
|
|
1804
|
+
type: string
|
|
1805
|
+
required: false
|
|
1806
|
+
productClassificationId:
|
|
1807
|
+
description: Id of the productClassification.
|
|
1808
|
+
type: string
|
|
1809
|
+
required: false
|
|
1810
|
+
qualificationProcedure:
|
|
1811
|
+
description: Qualification Procedure Name
|
|
1812
|
+
type: string
|
|
1813
|
+
required: false
|
|
1814
|
+
relatedObjectFilters:
|
|
1815
|
+
description: RelatedObjectFilters
|
|
1816
|
+
type: array
|
|
1817
|
+
required: false
|
|
1818
|
+
items:
|
|
1819
|
+
type: RelatedObjectFilterInputRepresentation
|
|
1820
|
+
userContext:
|
|
1821
|
+
description: User context
|
|
1822
|
+
type: object
|
|
1823
|
+
required: false
|
|
1824
|
+
guidedSelectionResponseId:
|
|
1825
|
+
description: Guided Selection Response Identifier
|
|
1826
|
+
type: string
|
|
1827
|
+
required: false
|
|
1828
|
+
searchTerms:
|
|
1829
|
+
description: Guided Selection Search Terms
|
|
1830
|
+
type: array
|
|
1831
|
+
required: false
|
|
1832
|
+
items:
|
|
1833
|
+
type: GuidedSelectionSearchTermInputRepresentation
|
|
1834
|
+
SmartSelectionSearchInputRepresentation:
|
|
1835
|
+
description: Input Representation for smart product selection.
|
|
1836
|
+
type: object
|
|
1837
|
+
properties:
|
|
1838
|
+
catalogId:
|
|
1839
|
+
description: Id of the catalog.
|
|
1840
|
+
type: string
|
|
1841
|
+
required: false
|
|
1842
|
+
priceBookId:
|
|
1843
|
+
description: Id of pricebook.
|
|
1844
|
+
type: string
|
|
1845
|
+
required: false
|
|
1846
|
+
currencyCode:
|
|
1847
|
+
description: currency Code.
|
|
1848
|
+
type: string
|
|
1849
|
+
required: false
|
|
1850
|
+
limit:
|
|
1851
|
+
description: Number of item to be returned from semantic API
|
|
1852
|
+
type: integer
|
|
1853
|
+
required: false
|
|
1854
|
+
enableQualification:
|
|
1855
|
+
description: Enable Qualification
|
|
1856
|
+
type: boolean
|
|
1857
|
+
required: false
|
|
1858
|
+
enablePricing:
|
|
1859
|
+
description: Enable Pricing
|
|
1860
|
+
type: boolean
|
|
1861
|
+
required: false
|
|
1862
|
+
query:
|
|
1863
|
+
description: List of user queries
|
|
1864
|
+
type: array
|
|
1865
|
+
items:
|
|
1866
|
+
type: string
|
|
1867
|
+
SmartSelectionInputRepresentation:
|
|
1868
|
+
description: Input Representation for smart product selection.
|
|
1869
|
+
type: object
|
|
1870
|
+
properties:
|
|
1871
|
+
chatContextId:
|
|
1872
|
+
description: Id of the catalog.
|
|
1873
|
+
type: string
|
|
1874
|
+
required: false
|
|
1875
|
+
maxToken:
|
|
1876
|
+
description: Number of item count you want in the response
|
|
1877
|
+
type: integer
|
|
1878
|
+
required: false
|
|
1879
|
+
temperature:
|
|
1880
|
+
description: Max Quantity allowed of a product
|
|
1881
|
+
format: float
|
|
1882
|
+
type: number
|
|
1883
|
+
required: false
|
|
1884
|
+
searchParams:
|
|
1885
|
+
description: Smart product selection search params
|
|
1886
|
+
required: false
|
|
1887
|
+
type: SmartSelectionSearchInputRepresentation
|
|
1888
|
+
GuidedSelectionSearchTermOutputRepresentation:
|
|
1889
|
+
description: Guided selection search term output representation
|
|
1890
|
+
type: object
|
|
1891
|
+
properties:
|
|
1892
|
+
tags:
|
|
1893
|
+
description: Guided Selection Search Term tags
|
|
1894
|
+
type: array
|
|
1895
|
+
items:
|
|
1896
|
+
type: string
|
|
1897
|
+
term:
|
|
1898
|
+
description: Guided Selection Search Term value
|
|
1899
|
+
type: string
|
|
1900
|
+
GuidedSelectionOutputRepresentation:
|
|
1901
|
+
description: Guided selection output representation
|
|
1902
|
+
type: object
|
|
1903
|
+
properties:
|
|
1904
|
+
apiStatus:
|
|
1905
|
+
description: Api Status Object
|
|
1906
|
+
type: ApiStatusOutputRepresentation
|
|
1907
|
+
contextId:
|
|
1908
|
+
description: ContextId
|
|
1909
|
+
type: string
|
|
1910
|
+
required: false
|
|
1911
|
+
correlationId:
|
|
1912
|
+
description: CorrelationId
|
|
1913
|
+
type: string
|
|
1914
|
+
required: false
|
|
1915
|
+
cursor:
|
|
1916
|
+
description: Cursor
|
|
1917
|
+
type: string
|
|
1918
|
+
required: false
|
|
1919
|
+
limit:
|
|
1920
|
+
description: Limit
|
|
1921
|
+
type: integer
|
|
1922
|
+
required: false
|
|
1923
|
+
offSet:
|
|
1924
|
+
description: Offset
|
|
1925
|
+
type: integer
|
|
1926
|
+
required: false
|
|
1927
|
+
result:
|
|
1928
|
+
description: Result object
|
|
1929
|
+
type: array
|
|
1930
|
+
items:
|
|
1931
|
+
type: object
|
|
1932
|
+
total:
|
|
1933
|
+
description: Totals
|
|
1934
|
+
type: integer
|
|
1935
|
+
required: false
|
|
1936
|
+
userContext:
|
|
1937
|
+
description: User Context
|
|
1938
|
+
type: object
|
|
1939
|
+
required: false
|
|
1940
|
+
searchTerms:
|
|
1941
|
+
description: Guided Selection Search Terms
|
|
1942
|
+
type: array
|
|
1943
|
+
required: false
|
|
1944
|
+
items:
|
|
1945
|
+
type: GuidedSelectionSearchTermOutputRepresentation
|
|
1946
|
+
SmartSelectionOutputRepresentation:
|
|
1947
|
+
description: Smart product selection output representation
|
|
1948
|
+
type: object
|
|
1949
|
+
properties:
|
|
1950
|
+
apiStatus:
|
|
1951
|
+
description: Api Status Object
|
|
1952
|
+
type: ApiStatusOutputRepresentation
|
|
1953
|
+
productIds:
|
|
1954
|
+
description: List of recommended product id's
|
|
1955
|
+
type: array
|
|
1956
|
+
items:
|
|
1957
|
+
type: string
|
|
1958
|
+
queryResponse:
|
|
1959
|
+
description: LLM Response for user query
|
|
1960
|
+
type: string
|
|
1961
|
+
required: false
|
|
1962
|
+
chatContextId:
|
|
1963
|
+
description: LLM Response for user query
|
|
1964
|
+
type: string
|
|
1965
|
+
required: false
|
|
1966
|
+
PreviewInputRepresentation:
|
|
1967
|
+
description: Input Representation for Preview Product or cart item.
|
|
1968
|
+
type: object
|
|
1969
|
+
properties:
|
|
1970
|
+
cartId:
|
|
1971
|
+
description: Id of the Cart to which ths conigured items belongs to.
|
|
1972
|
+
type: string
|
|
1973
|
+
required: false
|
|
1974
|
+
configuredItems:
|
|
1975
|
+
description: Items to be configure and update to the cart.
|
|
1976
|
+
type: array
|
|
1977
|
+
required: false
|
|
1978
|
+
items:
|
|
1979
|
+
type: object
|
|
1980
|
+
correlationId:
|
|
1981
|
+
description: CorrelationId
|
|
1982
|
+
type: string
|
|
1983
|
+
required: false
|
|
1984
|
+
customFields:
|
|
1985
|
+
description: Key value pair of custom fields.
|
|
1986
|
+
type: object
|
|
1987
|
+
required: false
|
|
1988
|
+
properties:
|
|
1989
|
+
//:
|
|
1990
|
+
type: string
|
|
1991
|
+
userContext:
|
|
1992
|
+
description: User context in which cart would be created.
|
|
1993
|
+
type: object
|
|
1994
|
+
required: false
|
|
1995
|
+
PricingModelOutputRepresentation:
|
|
1996
|
+
description: Pricing Model representation
|
|
1997
|
+
type: object
|
|
1998
|
+
properties:
|
|
1999
|
+
frequency:
|
|
2000
|
+
description: Frequency of Recurrence
|
|
2001
|
+
type: string
|
|
2002
|
+
required: false
|
|
2003
|
+
id:
|
|
2004
|
+
description: Price Model Id
|
|
2005
|
+
type: string
|
|
2006
|
+
required: false
|
|
2007
|
+
name:
|
|
2008
|
+
description: Name of Pricing Model
|
|
2009
|
+
type: string
|
|
2010
|
+
required: false
|
|
2011
|
+
occurrence:
|
|
2012
|
+
description: Number of occurrences
|
|
2013
|
+
type: integer
|
|
2014
|
+
required: false
|
|
2015
|
+
pricingModelType:
|
|
2016
|
+
description: Type of Pricing Model
|
|
2017
|
+
type: string
|
|
2018
|
+
required: false
|
|
2019
|
+
unitOfMeasure:
|
|
2020
|
+
description: Unit of Measure
|
|
2021
|
+
type: string
|
|
2022
|
+
required: false
|
|
2023
|
+
ProductAttributeOutputRepresentation:
|
|
2024
|
+
description: Product Attributes output representation
|
|
2025
|
+
type: object
|
|
2026
|
+
properties:
|
|
2027
|
+
additionalFields:
|
|
2028
|
+
description: Map of additional fields
|
|
2029
|
+
type: object
|
|
2030
|
+
required: false
|
|
2031
|
+
attributeCategoryId:
|
|
2032
|
+
description: Attribute Category Id
|
|
2033
|
+
type: string
|
|
2034
|
+
required: false
|
|
2035
|
+
attributePickList:
|
|
2036
|
+
description: Attribute picklist in product attribute
|
|
2037
|
+
type: AttributePickListOutputRepresentation
|
|
2038
|
+
required: false
|
|
2039
|
+
code:
|
|
2040
|
+
description: Code of the attribute
|
|
2041
|
+
type: string
|
|
2042
|
+
required: false
|
|
2043
|
+
dataType:
|
|
2044
|
+
description: DataType of product attribute
|
|
2045
|
+
type: string
|
|
2046
|
+
required: false
|
|
2047
|
+
defaultHelpText:
|
|
2048
|
+
description: Help text of the attribute
|
|
2049
|
+
type: string
|
|
2050
|
+
required: false
|
|
2051
|
+
defaultValue:
|
|
2052
|
+
description: Default of the attribute
|
|
2053
|
+
type: string
|
|
2054
|
+
required: false
|
|
2055
|
+
description:
|
|
2056
|
+
description: description of product attribute
|
|
2057
|
+
type: string
|
|
2058
|
+
required: false
|
|
2059
|
+
hidden:
|
|
2060
|
+
description: Is true if attribute is hidden
|
|
2061
|
+
type: boolean
|
|
2062
|
+
required: false
|
|
2063
|
+
id:
|
|
2064
|
+
description: Id of product attribute
|
|
2065
|
+
type: string
|
|
2066
|
+
required: false
|
|
2067
|
+
isCloneable:
|
|
2068
|
+
description: Is true if attribute is cloneable
|
|
2069
|
+
type: boolean
|
|
2070
|
+
required: false
|
|
2071
|
+
isConfigurable:
|
|
2072
|
+
description: Is true if attribute is configurable
|
|
2073
|
+
type: boolean
|
|
2074
|
+
required: false
|
|
2075
|
+
isEncrypted:
|
|
2076
|
+
description: Is true if attribute is encrypted
|
|
2077
|
+
type: boolean
|
|
2078
|
+
required: false
|
|
2079
|
+
isPriceImpacting:
|
|
2080
|
+
description: Is Price Impacting field in attribute
|
|
2081
|
+
type: boolean
|
|
2082
|
+
required: false
|
|
2083
|
+
sequence:
|
|
2084
|
+
description: Sequence of the attribute
|
|
2085
|
+
type: integer
|
|
2086
|
+
required: false
|
|
2087
|
+
attributeNameOverride:
|
|
2088
|
+
description: overrided name of the attribute
|
|
2089
|
+
type: string
|
|
2090
|
+
required: false
|
|
2091
|
+
valueDescription:
|
|
2092
|
+
description: value description of the attribute
|
|
2093
|
+
type: string
|
|
2094
|
+
required: false
|
|
2095
|
+
displayType:
|
|
2096
|
+
description: display type of the attribute
|
|
2097
|
+
type: string
|
|
2098
|
+
required: false
|
|
2099
|
+
isReadOnly:
|
|
2100
|
+
description: Is true if attribute is read only
|
|
2101
|
+
type: boolean
|
|
2102
|
+
required: false
|
|
2103
|
+
isRequired:
|
|
2104
|
+
description: Is true if attribute is required
|
|
2105
|
+
type: boolean
|
|
2106
|
+
required: false
|
|
2107
|
+
label:
|
|
2108
|
+
description: Label of the attribute
|
|
2109
|
+
type: string
|
|
2110
|
+
required: false
|
|
2111
|
+
name:
|
|
2112
|
+
description: name of product attribute
|
|
2113
|
+
type: string
|
|
2114
|
+
required: false
|
|
2115
|
+
developerName:
|
|
2116
|
+
description: developer name of product attribute
|
|
2117
|
+
type: string
|
|
2118
|
+
required: false
|
|
2119
|
+
status:
|
|
2120
|
+
description: Status of product attribute - Active/InActive
|
|
2121
|
+
type: string
|
|
2122
|
+
required: false
|
|
2123
|
+
userValue:
|
|
2124
|
+
description: user value of the product attribute
|
|
2125
|
+
type: string
|
|
2126
|
+
required: false
|
|
2127
|
+
minimumValue:
|
|
2128
|
+
description: minimum value of the attribute
|
|
2129
|
+
type: string
|
|
2130
|
+
required: false
|
|
2131
|
+
maximumValue:
|
|
2132
|
+
description: maximum value of the attribute
|
|
2133
|
+
type: string
|
|
2134
|
+
required: false
|
|
2135
|
+
stepValue:
|
|
2136
|
+
description: step increment/decrement value of the attribute
|
|
2137
|
+
type: string
|
|
2138
|
+
required: false
|
|
2139
|
+
valueDecoder:
|
|
2140
|
+
description: parsable decoder of the attribute
|
|
2141
|
+
type: string
|
|
2142
|
+
required: false
|
|
2143
|
+
ProductConfigurationInputRepresentation:
|
|
2144
|
+
description: Input Representation for Product Configuration.
|
|
2145
|
+
type: object
|
|
2146
|
+
properties:
|
|
2147
|
+
configuration:
|
|
2148
|
+
description: Product delta configurations
|
|
2149
|
+
type: object
|
|
2150
|
+
required: false
|
|
2151
|
+
productId:
|
|
2152
|
+
description: Product Id
|
|
2153
|
+
type: string
|
|
2154
|
+
required: false
|
|
2155
|
+
ProductDeltaConfigurationInputRepresentation:
|
|
2156
|
+
description: Input Representation for Product Delta Configuration.
|
|
2157
|
+
type: object
|
|
2158
|
+
properties:
|
|
2159
|
+
attributes:
|
|
2160
|
+
description: Product attribute configuration
|
|
2161
|
+
type: object
|
|
2162
|
+
required: false
|
|
2163
|
+
properties:
|
|
2164
|
+
//:
|
|
2165
|
+
type: object
|
|
2166
|
+
quantity:
|
|
2167
|
+
description: Product quantity
|
|
2168
|
+
format: double
|
|
2169
|
+
type: number
|
|
2170
|
+
required: false
|
|
2171
|
+
ProductDetailsInputRepresentation:
|
|
2172
|
+
description: Input Representation for Product Details.
|
|
2173
|
+
type: object
|
|
2174
|
+
properties:
|
|
2175
|
+
additionalFields:
|
|
2176
|
+
description: Key value pair of additional fields
|
|
2177
|
+
type: object
|
|
2178
|
+
required: false
|
|
2179
|
+
catalogId:
|
|
2180
|
+
description: Id of the catalog.
|
|
2181
|
+
type: string
|
|
2182
|
+
required: false
|
|
2183
|
+
correlationId:
|
|
2184
|
+
description: CorrelationId
|
|
2185
|
+
type: string
|
|
2186
|
+
required: false
|
|
2187
|
+
priceBookId:
|
|
2188
|
+
description: Id of the price Book.
|
|
2189
|
+
type: string
|
|
2190
|
+
productSellingModelId:
|
|
2191
|
+
description: PSM of the product.
|
|
2192
|
+
type: string
|
|
2193
|
+
required: false
|
|
2194
|
+
userContext:
|
|
2195
|
+
description: User context
|
|
2196
|
+
type: object
|
|
2197
|
+
required: false
|
|
2198
|
+
ProductDetailsOutputRepresentation:
|
|
2199
|
+
description: Product details output representation
|
|
2200
|
+
type: object
|
|
2201
|
+
properties:
|
|
2202
|
+
attributes:
|
|
2203
|
+
description: List of attributes in the product
|
|
2204
|
+
type: array
|
|
2205
|
+
required: false
|
|
2206
|
+
items:
|
|
2207
|
+
type: ProductAttributeOutputRepresentation
|
|
2208
|
+
childProducts:
|
|
2209
|
+
description: List of Child products
|
|
2210
|
+
type: array
|
|
2211
|
+
required: false
|
|
2212
|
+
items:
|
|
2213
|
+
type: ProductDetailsOutputRepresentation
|
|
2214
|
+
displayName:
|
|
2215
|
+
description: DisplayName of the product
|
|
2216
|
+
type: string
|
|
2217
|
+
required: false
|
|
2218
|
+
prices:
|
|
2219
|
+
description: List of prices of the product
|
|
2220
|
+
type: array
|
|
2221
|
+
required: false
|
|
2222
|
+
items:
|
|
2223
|
+
type: ProductPricesOutputRepresentation
|
|
2224
|
+
quantity:
|
|
2225
|
+
description: quantity of the product
|
|
2226
|
+
type: string
|
|
2227
|
+
required: false
|
|
2228
|
+
additionalFields:
|
|
2229
|
+
description: Map of additional fields
|
|
2230
|
+
type: object
|
|
2231
|
+
required: false
|
|
2232
|
+
attributeCategories:
|
|
2233
|
+
description: List of attribute categories in a product
|
|
2234
|
+
type: array
|
|
2235
|
+
required: false
|
|
2236
|
+
items:
|
|
2237
|
+
type: AttributeCategoryOutputRepresentation
|
|
2238
|
+
description:
|
|
2239
|
+
description: Description of the product
|
|
2240
|
+
type: string
|
|
2241
|
+
required: false
|
|
2242
|
+
id:
|
|
2243
|
+
description: Id of the product
|
|
2244
|
+
type: string
|
|
2245
|
+
required: false
|
|
2246
|
+
isComponentRequired:
|
|
2247
|
+
description: Is Component required of a product
|
|
2248
|
+
type: boolean
|
|
2249
|
+
required: false
|
|
2250
|
+
isDefaultComponent:
|
|
2251
|
+
description: Is the product a Default Component
|
|
2252
|
+
type: boolean
|
|
2253
|
+
required: false
|
|
2254
|
+
isQuantityEditable:
|
|
2255
|
+
description: Is Quantity of product editable
|
|
2256
|
+
type: boolean
|
|
2257
|
+
required: false
|
|
2258
|
+
name:
|
|
2259
|
+
description: Name of the product
|
|
2260
|
+
type: string
|
|
2261
|
+
required: false
|
|
2262
|
+
productCode:
|
|
2263
|
+
description: Code of the product
|
|
2264
|
+
type: string
|
|
2265
|
+
required: false
|
|
2266
|
+
productType:
|
|
2267
|
+
description: Type of the product
|
|
2268
|
+
type: string
|
|
2269
|
+
required: false
|
|
2270
|
+
configureDuringSale:
|
|
2271
|
+
description: ConfigureDuringSale of the product
|
|
2272
|
+
type: string
|
|
2273
|
+
required: false
|
|
2274
|
+
displayUrl:
|
|
2275
|
+
description: displayUrl of the product
|
|
2276
|
+
type: string
|
|
2277
|
+
required: false
|
|
2278
|
+
nodeType:
|
|
2279
|
+
description: nodeType of the product
|
|
2280
|
+
type: string
|
|
2281
|
+
required: false
|
|
2282
|
+
discontinuedDate:
|
|
2283
|
+
description: discontinuedDate of the product
|
|
2284
|
+
type: string
|
|
2285
|
+
required: false
|
|
2286
|
+
availabilityDate:
|
|
2287
|
+
description: availabilityDate of the product
|
|
2288
|
+
type: string
|
|
2289
|
+
required: false
|
|
2290
|
+
endOfLifeDate:
|
|
2291
|
+
description: endOfLifeDate of the product
|
|
2292
|
+
type: string
|
|
2293
|
+
required: false
|
|
2294
|
+
isAssetizable:
|
|
2295
|
+
description: Is the product Assetizable
|
|
2296
|
+
type: boolean
|
|
2297
|
+
required: false
|
|
2298
|
+
isActive:
|
|
2299
|
+
description: Is the product Active
|
|
2300
|
+
type: boolean
|
|
2301
|
+
required: false
|
|
2302
|
+
isSoldOnlyWithOtherProds:
|
|
2303
|
+
description: Is the product Sold Only With Other Products
|
|
2304
|
+
type: boolean
|
|
2305
|
+
required: false
|
|
2306
|
+
qualificationContext:
|
|
2307
|
+
description: Qualification Status of a product
|
|
2308
|
+
type: QualificationContextOutputRepresentation
|
|
2309
|
+
required: false
|
|
2310
|
+
productRelatedComponent:
|
|
2311
|
+
description: PRC of a product
|
|
2312
|
+
type: ProductRelatedComponentOutputRepresentation
|
|
2313
|
+
required: false
|
|
2314
|
+
productComponentGroups:
|
|
2315
|
+
description: List of PCG in a product
|
|
2316
|
+
type: array
|
|
2317
|
+
required: false
|
|
2318
|
+
items:
|
|
2319
|
+
type: ProductComponentGroupOutputRepresentation
|
|
2320
|
+
productSellingModelOptions:
|
|
2321
|
+
description: PSMs of a product
|
|
2322
|
+
type: array
|
|
2323
|
+
required: false
|
|
2324
|
+
items:
|
|
2325
|
+
type: ProductSellingModelOptionOutputRepresentation
|
|
2326
|
+
productClassification:
|
|
2327
|
+
description: Classification of a product
|
|
2328
|
+
type: ProductClassificationOutputRepresentation
|
|
2329
|
+
required: false
|
|
2330
|
+
productSpecificationType:
|
|
2331
|
+
description: SpecificationType of a product
|
|
2332
|
+
type: ProductSpecificationTypeOutputRepresentation
|
|
2333
|
+
required: false
|
|
2334
|
+
productQuantity:
|
|
2335
|
+
description: Quantity information of a product
|
|
2336
|
+
type: ProductQuantityOutputRepresentation
|
|
2337
|
+
required: false
|
|
2338
|
+
status:
|
|
2339
|
+
description: Status of the product
|
|
2340
|
+
type: string
|
|
2341
|
+
required: false
|
|
2342
|
+
ProductListInputRepresentation:
|
|
2343
|
+
description: Input Representation for Product List.
|
|
2344
|
+
type: object
|
|
2345
|
+
properties:
|
|
2346
|
+
additionalFields:
|
|
2347
|
+
description: Key value pair of additional fields
|
|
2348
|
+
type: object
|
|
2349
|
+
required: false
|
|
2350
|
+
catalogId:
|
|
2351
|
+
description: Id of the catalog.
|
|
2352
|
+
type: string
|
|
2353
|
+
required: false
|
|
2354
|
+
categoryId:
|
|
2355
|
+
description: Id of the catalog.
|
|
2356
|
+
type: string
|
|
2357
|
+
required: false
|
|
2358
|
+
correlationId:
|
|
2359
|
+
description: CorrelationId
|
|
2360
|
+
type: string
|
|
2361
|
+
required: false
|
|
2362
|
+
limit:
|
|
2363
|
+
description: Number of item count you want in the response
|
|
2364
|
+
type: integer
|
|
2365
|
+
required: false
|
|
2366
|
+
offset:
|
|
2367
|
+
description: Offset size from which you need the catalog count
|
|
2368
|
+
type: integer
|
|
2369
|
+
required: false
|
|
2370
|
+
priceBookId:
|
|
2371
|
+
description: Id of the price Book.
|
|
2372
|
+
type: string
|
|
2373
|
+
cursor:
|
|
2374
|
+
description: cursor for pagination
|
|
2375
|
+
type: string
|
|
2376
|
+
required: false
|
|
2377
|
+
orderBy:
|
|
2378
|
+
description: Sort by ascending/descending order
|
|
2379
|
+
type: array
|
|
2380
|
+
required: false
|
|
2381
|
+
items:
|
|
2382
|
+
type: string
|
|
2383
|
+
userContext:
|
|
2384
|
+
description: User context
|
|
2385
|
+
type: object
|
|
2386
|
+
required: false
|
|
2387
|
+
filter:
|
|
2388
|
+
description: Filters
|
|
2389
|
+
type: object
|
|
2390
|
+
required: false
|
|
2391
|
+
usePromotions:
|
|
2392
|
+
description: Enable Promotion Rules
|
|
2393
|
+
type: boolean
|
|
2394
|
+
required: false
|
|
2395
|
+
ProductListOutputRepresentation:
|
|
2396
|
+
description: Product list output representation
|
|
2397
|
+
type: object
|
|
2398
|
+
properties:
|
|
2399
|
+
childProducts:
|
|
2400
|
+
description: List of Child Products
|
|
2401
|
+
type: array
|
|
2402
|
+
required: false
|
|
2403
|
+
items:
|
|
2404
|
+
type: ProductListOutputRepresentation
|
|
2405
|
+
eligiblePromotions:
|
|
2406
|
+
description: List of promotions for the product
|
|
2407
|
+
type: array
|
|
2408
|
+
items:
|
|
2409
|
+
type: PromotionOutputRepresentation
|
|
2410
|
+
prices:
|
|
2411
|
+
description: List of prices of the product
|
|
2412
|
+
type: array
|
|
2413
|
+
required: false
|
|
2414
|
+
items:
|
|
2415
|
+
type: ProductPricesOutputRepresentation
|
|
2416
|
+
additionalFields:
|
|
2417
|
+
description: Map of additional fields
|
|
2418
|
+
type: object
|
|
2419
|
+
required: false
|
|
2420
|
+
attributeCategories:
|
|
2421
|
+
description: List of attribute categories in a product
|
|
2422
|
+
type: array
|
|
2423
|
+
required: false
|
|
2424
|
+
items:
|
|
2425
|
+
type: AttributeCategoryOutputRepresentation
|
|
2426
|
+
description:
|
|
2427
|
+
description: Description of the product
|
|
2428
|
+
type: string
|
|
2429
|
+
required: false
|
|
2430
|
+
id:
|
|
2431
|
+
description: Id of the product
|
|
2432
|
+
type: string
|
|
2433
|
+
required: false
|
|
2434
|
+
isComponentRequired:
|
|
2435
|
+
description: Is Component required of a product
|
|
2436
|
+
type: boolean
|
|
2437
|
+
required: false
|
|
2438
|
+
isDefaultComponent:
|
|
2439
|
+
description: Is the product a Default Component
|
|
2440
|
+
type: boolean
|
|
2441
|
+
required: false
|
|
2442
|
+
isQuantityEditable:
|
|
2443
|
+
description: Is Quantity of product editable
|
|
2444
|
+
type: boolean
|
|
2445
|
+
required: false
|
|
2446
|
+
name:
|
|
2447
|
+
description: Name of the product
|
|
2448
|
+
type: string
|
|
2449
|
+
required: false
|
|
2450
|
+
productCode:
|
|
2451
|
+
description: Code of the product
|
|
2452
|
+
type: string
|
|
2453
|
+
required: false
|
|
2454
|
+
productType:
|
|
2455
|
+
description: Type of the product
|
|
2456
|
+
type: string
|
|
2457
|
+
required: false
|
|
2458
|
+
configureDuringSale:
|
|
2459
|
+
description: ConfigureDuringSale of the product
|
|
2460
|
+
type: string
|
|
2461
|
+
required: false
|
|
2462
|
+
displayUrl:
|
|
2463
|
+
description: displayUrl of the product
|
|
2464
|
+
type: string
|
|
2465
|
+
required: false
|
|
2466
|
+
nodeType:
|
|
2467
|
+
description: nodeType of the product
|
|
2468
|
+
type: string
|
|
2469
|
+
required: false
|
|
2470
|
+
discontinuedDate:
|
|
2471
|
+
description: discontinuedDate of the product
|
|
2472
|
+
type: string
|
|
2473
|
+
required: false
|
|
2474
|
+
availabilityDate:
|
|
2475
|
+
description: availabilityDate of the product
|
|
2476
|
+
type: string
|
|
2477
|
+
required: false
|
|
2478
|
+
endOfLifeDate:
|
|
2479
|
+
description: endOfLifeDate of the product
|
|
2480
|
+
type: string
|
|
2481
|
+
required: false
|
|
2482
|
+
isAssetizable:
|
|
2483
|
+
description: Is the product Assetizable
|
|
2484
|
+
type: boolean
|
|
2485
|
+
required: false
|
|
2486
|
+
isActive:
|
|
2487
|
+
description: Is the product Active
|
|
2488
|
+
type: boolean
|
|
2489
|
+
required: false
|
|
2490
|
+
isSoldOnlyWithOtherProds:
|
|
2491
|
+
description: Is the product Sold Only With Other Products
|
|
2492
|
+
type: boolean
|
|
2493
|
+
required: false
|
|
2494
|
+
qualificationContext:
|
|
2495
|
+
description: Qualification Status of a product
|
|
2496
|
+
type: QualificationContextOutputRepresentation
|
|
2497
|
+
required: false
|
|
2498
|
+
productRelatedComponent:
|
|
2499
|
+
description: PRC of a product
|
|
2500
|
+
type: ProductRelatedComponentOutputRepresentation
|
|
2501
|
+
required: false
|
|
2502
|
+
productComponentGroups:
|
|
2503
|
+
description: List of PCG in a product
|
|
2504
|
+
type: array
|
|
2505
|
+
required: false
|
|
2506
|
+
items:
|
|
2507
|
+
type: ProductComponentGroupOutputRepresentation
|
|
2508
|
+
productSellingModelOptions:
|
|
2509
|
+
description: PSMs of a product
|
|
2510
|
+
type: array
|
|
2511
|
+
required: false
|
|
2512
|
+
items:
|
|
2513
|
+
type: ProductSellingModelOptionOutputRepresentation
|
|
2514
|
+
productClassification:
|
|
2515
|
+
description: Classification of a product
|
|
2516
|
+
type: ProductClassificationOutputRepresentation
|
|
2517
|
+
required: false
|
|
2518
|
+
productSpecificationType:
|
|
2519
|
+
description: SpecificationType of a product
|
|
2520
|
+
type: ProductSpecificationTypeOutputRepresentation
|
|
2521
|
+
required: false
|
|
2522
|
+
productQuantity:
|
|
2523
|
+
description: Quantity information of a product
|
|
2524
|
+
type: ProductQuantityOutputRepresentation
|
|
2525
|
+
required: false
|
|
2526
|
+
status:
|
|
2527
|
+
description: Status of the product
|
|
2528
|
+
type: string
|
|
2529
|
+
required: false
|
|
2530
|
+
ProductVariantAttributeOutputRepresentation:
|
|
2531
|
+
description: Product Variant Attribute representation
|
|
2532
|
+
type: object
|
|
2533
|
+
properties:
|
|
2534
|
+
attributeSetItemId:
|
|
2535
|
+
description: Attribute Set Item Id of the Attribute
|
|
2536
|
+
type: string
|
|
2537
|
+
required: false
|
|
2538
|
+
fieldId:
|
|
2539
|
+
description: Field Id of the Attribute
|
|
2540
|
+
type: string
|
|
2541
|
+
required: false
|
|
2542
|
+
fieldApiName:
|
|
2543
|
+
description: Field Api Name of the Attribute
|
|
2544
|
+
type: string
|
|
2545
|
+
required: false
|
|
2546
|
+
fieldLabel:
|
|
2547
|
+
description: Field Label of the Attribute
|
|
2548
|
+
type: string
|
|
2549
|
+
required: false
|
|
2550
|
+
ProductVariantAttributeValueOutputRepresentation:
|
|
2551
|
+
description: Product Variant Attribute value representation
|
|
2552
|
+
type: object
|
|
2553
|
+
properties:
|
|
2554
|
+
attribute:
|
|
2555
|
+
description: Attribute
|
|
2556
|
+
type: ProductVariantAttributeOutputRepresentation
|
|
2557
|
+
required: false
|
|
2558
|
+
value:
|
|
2559
|
+
description: Value of the Attribute
|
|
2560
|
+
type: object
|
|
2561
|
+
required: false
|
|
2562
|
+
ProductVariantAttributeSetOutputRepresentation:
|
|
2563
|
+
description: Product Variant Attribute Set representation
|
|
2564
|
+
type: object
|
|
2565
|
+
properties:
|
|
2566
|
+
id:
|
|
2567
|
+
description: Id of the Attribute Set
|
|
2568
|
+
type: string
|
|
2569
|
+
required: false
|
|
2570
|
+
developerName:
|
|
2571
|
+
description: Developer Name of the Attribute Set
|
|
2572
|
+
type: string
|
|
2573
|
+
required: false
|
|
2574
|
+
label:
|
|
2575
|
+
description: Label of the Attribute Set
|
|
2576
|
+
type: string
|
|
2577
|
+
required: false
|
|
2578
|
+
description:
|
|
2579
|
+
description: Description of the Attribute Set
|
|
2580
|
+
type: string
|
|
2581
|
+
required: false
|
|
2582
|
+
attributes:
|
|
2583
|
+
description: Attributes participating in the Attribute Set
|
|
2584
|
+
type: object
|
|
2585
|
+
required: false
|
|
2586
|
+
ProductOutputRepresentation:
|
|
2587
|
+
description: Product output representation
|
|
2588
|
+
type: object
|
|
2589
|
+
properties:
|
|
2590
|
+
childVariationIds:
|
|
2591
|
+
description: Child Variation Identifiers
|
|
2592
|
+
type: array
|
|
2593
|
+
required: false
|
|
2594
|
+
items:
|
|
2595
|
+
type: string
|
|
2596
|
+
variationAttributeSet:
|
|
2597
|
+
description: Product Variation Attribute Set
|
|
2598
|
+
type: ProductVariantAttributeSetOutputRepresentation
|
|
2599
|
+
required: false
|
|
2600
|
+
additionalFields:
|
|
2601
|
+
description: Map of additional fields
|
|
2602
|
+
type: object
|
|
2603
|
+
required: false
|
|
2604
|
+
attributeCategories:
|
|
2605
|
+
description: List of attribute categories in a product
|
|
2606
|
+
type: array
|
|
2607
|
+
required: false
|
|
2608
|
+
items:
|
|
2609
|
+
type: AttributeCategoryOutputRepresentation
|
|
2610
|
+
description:
|
|
2611
|
+
description: Description of the product
|
|
2612
|
+
type: string
|
|
2613
|
+
required: false
|
|
2614
|
+
id:
|
|
2615
|
+
description: Id of the product
|
|
2616
|
+
type: string
|
|
2617
|
+
required: false
|
|
2618
|
+
isComponentRequired:
|
|
2619
|
+
description: Is Component required of a product
|
|
2620
|
+
type: boolean
|
|
2621
|
+
required: false
|
|
2622
|
+
isDefaultComponent:
|
|
2623
|
+
description: Is the product a Default Component
|
|
2624
|
+
type: boolean
|
|
2625
|
+
required: false
|
|
2626
|
+
isQuantityEditable:
|
|
2627
|
+
description: Is Quantity of product editable
|
|
2628
|
+
type: boolean
|
|
2629
|
+
required: false
|
|
2630
|
+
name:
|
|
2631
|
+
description: Name of the product
|
|
2632
|
+
type: string
|
|
2633
|
+
required: false
|
|
2634
|
+
productCode:
|
|
2635
|
+
description: Code of the product
|
|
2636
|
+
type: string
|
|
2637
|
+
required: false
|
|
2638
|
+
productType:
|
|
2639
|
+
description: Type of the product
|
|
2640
|
+
type: string
|
|
2641
|
+
required: false
|
|
2642
|
+
configureDuringSale:
|
|
2643
|
+
description: ConfigureDuringSale of the product
|
|
2644
|
+
type: string
|
|
2645
|
+
required: false
|
|
2646
|
+
displayUrl:
|
|
2647
|
+
description: displayUrl of the product
|
|
2648
|
+
type: string
|
|
2649
|
+
required: false
|
|
2650
|
+
nodeType:
|
|
2651
|
+
description: nodeType of the product
|
|
2652
|
+
type: string
|
|
2653
|
+
required: false
|
|
2654
|
+
discontinuedDate:
|
|
2655
|
+
description: discontinuedDate of the product
|
|
2656
|
+
type: string
|
|
2657
|
+
required: false
|
|
2658
|
+
availabilityDate:
|
|
2659
|
+
description: availabilityDate of the product
|
|
2660
|
+
type: string
|
|
2661
|
+
required: false
|
|
2662
|
+
endOfLifeDate:
|
|
2663
|
+
description: endOfLifeDate of the product
|
|
2664
|
+
type: string
|
|
2665
|
+
required: false
|
|
2666
|
+
isAssetizable:
|
|
2667
|
+
description: Is the product Assetizable
|
|
2668
|
+
type: boolean
|
|
2669
|
+
required: false
|
|
2670
|
+
isActive:
|
|
2671
|
+
description: Is the product Active
|
|
2672
|
+
type: boolean
|
|
2673
|
+
required: false
|
|
2674
|
+
isSoldOnlyWithOtherProds:
|
|
2675
|
+
description: Is the product Sold Only With Other Products
|
|
2676
|
+
type: boolean
|
|
2677
|
+
required: false
|
|
2678
|
+
qualificationContext:
|
|
2679
|
+
description: Qualification Status of a product
|
|
2680
|
+
type: QualificationContextOutputRepresentation
|
|
2681
|
+
required: false
|
|
2682
|
+
productRelatedComponent:
|
|
2683
|
+
description: PRC of a product
|
|
2684
|
+
type: ProductRelatedComponentOutputRepresentation
|
|
2685
|
+
required: false
|
|
2686
|
+
productComponentGroups:
|
|
2687
|
+
description: List of PCG in a product
|
|
2688
|
+
type: array
|
|
2689
|
+
required: false
|
|
2690
|
+
items:
|
|
2691
|
+
type: ProductComponentGroupOutputRepresentation
|
|
2692
|
+
productSellingModelOptions:
|
|
2693
|
+
description: PSMs of a product
|
|
2694
|
+
type: array
|
|
2695
|
+
required: false
|
|
2696
|
+
items:
|
|
2697
|
+
type: ProductSellingModelOptionOutputRepresentation
|
|
2698
|
+
productClassification:
|
|
2699
|
+
description: Classification of a product
|
|
2700
|
+
type: ProductClassificationOutputRepresentation
|
|
2701
|
+
required: false
|
|
2702
|
+
productSpecificationType:
|
|
2703
|
+
description: SpecificationType of a product
|
|
2704
|
+
type: ProductSpecificationTypeOutputRepresentation
|
|
2705
|
+
required: false
|
|
2706
|
+
productQuantity:
|
|
2707
|
+
description: Quantity information of a product
|
|
2708
|
+
type: ProductQuantityOutputRepresentation
|
|
2709
|
+
required: false
|
|
2710
|
+
status:
|
|
2711
|
+
description: Status of the product
|
|
2712
|
+
type: string
|
|
2713
|
+
required: false
|
|
2714
|
+
PromotionOutputRepresentation:
|
|
2715
|
+
description: Promotion output representation
|
|
2716
|
+
type: object
|
|
2717
|
+
properties:
|
|
2718
|
+
couponCode:
|
|
2719
|
+
description: Coupon code for the promotion
|
|
2720
|
+
type: string
|
|
2721
|
+
description:
|
|
2722
|
+
description: Description of the promotion
|
|
2723
|
+
type: string
|
|
2724
|
+
displayName:
|
|
2725
|
+
description: Display name of the promotion
|
|
2726
|
+
type: string
|
|
2727
|
+
endDateTime:
|
|
2728
|
+
description: End date and time of the promotion
|
|
2729
|
+
type: string
|
|
2730
|
+
id:
|
|
2731
|
+
description: Id of the promotion
|
|
2732
|
+
type: string
|
|
2733
|
+
isAutomatic:
|
|
2734
|
+
description: Whether the promotion is automatic
|
|
2735
|
+
type: boolean
|
|
2736
|
+
isCategoryPromo:
|
|
2737
|
+
description: Whether the promotion is a category level promotion
|
|
2738
|
+
type: boolean
|
|
2739
|
+
isProductPromo:
|
|
2740
|
+
description: Whether the promotion is a product level promotion
|
|
2741
|
+
type: boolean
|
|
2742
|
+
name:
|
|
2743
|
+
description: Name of the promotion
|
|
2744
|
+
type: string
|
|
2745
|
+
priority:
|
|
2746
|
+
description: Priority of the promotion
|
|
2747
|
+
type: integer
|
|
2748
|
+
startDateTime:
|
|
2749
|
+
description: Start date and time of the promotion
|
|
2750
|
+
type: string
|
|
2751
|
+
termsAndConditions:
|
|
2752
|
+
description: Terms and conditions of the promotion
|
|
2753
|
+
type: string
|
|
2754
|
+
CategoryDetailsInputRepresentation:
|
|
2755
|
+
description: Input Representation for Category Details.
|
|
2756
|
+
type: object
|
|
2757
|
+
properties:
|
|
2758
|
+
additionalContextData:
|
|
2759
|
+
description: Additional Context Data
|
|
2760
|
+
type: any
|
|
2761
|
+
required: false
|
|
2762
|
+
catalogId:
|
|
2763
|
+
description: Id of the catalog.
|
|
2764
|
+
type: string
|
|
2765
|
+
required: false
|
|
2766
|
+
contextDefinition:
|
|
2767
|
+
description: Context Definition Name
|
|
2768
|
+
type: string
|
|
2769
|
+
required: false
|
|
2770
|
+
contextMapping:
|
|
2771
|
+
description: Context Mapping Name
|
|
2772
|
+
type: string
|
|
2773
|
+
required: false
|
|
2774
|
+
correlationId:
|
|
2775
|
+
description: CorrelationId
|
|
2776
|
+
type: string
|
|
2777
|
+
required: false
|
|
2778
|
+
customFields:
|
|
2779
|
+
description: Key value pair of custom fields
|
|
2780
|
+
type: array
|
|
2781
|
+
required: false
|
|
2782
|
+
items:
|
|
2783
|
+
type: string
|
|
2784
|
+
enableQualification:
|
|
2785
|
+
description: Enable Qualification
|
|
2786
|
+
type: boolean
|
|
2787
|
+
required: false
|
|
2788
|
+
usePromotions:
|
|
2789
|
+
description: Enable Promotion
|
|
2790
|
+
type: boolean
|
|
2791
|
+
required: false
|
|
2792
|
+
filter:
|
|
2793
|
+
description: Filter criteria
|
|
2794
|
+
type: FilterInputRepresentation
|
|
2795
|
+
required: false
|
|
2796
|
+
qualificationProcedure:
|
|
2797
|
+
description: Qualification Procedure Name
|
|
2798
|
+
type: string
|
|
2799
|
+
required: false
|
|
2800
|
+
userContext:
|
|
2801
|
+
description: User context
|
|
2802
|
+
type: object
|
|
2803
|
+
required: false
|
|
2804
|
+
properties:
|
|
2805
|
+
//:
|
|
2806
|
+
type: any
|
|
2807
|
+
CategoryDetailsOutputRepresentation:
|
|
2808
|
+
description: Category details output representation
|
|
2809
|
+
type: object
|
|
2810
|
+
properties:
|
|
2811
|
+
childCategories:
|
|
2812
|
+
description: Child Categories
|
|
2813
|
+
type: array
|
|
2814
|
+
items:
|
|
2815
|
+
type: CategoryDetailsOutputRepresentation
|
|
2816
|
+
catalogId:
|
|
2817
|
+
description: Id of the catalog the requested category belong to
|
|
2818
|
+
type: string
|
|
2819
|
+
customFields:
|
|
2820
|
+
description: Custom Fields
|
|
2821
|
+
type: object
|
|
2822
|
+
properties:
|
|
2823
|
+
//:
|
|
2824
|
+
type: any
|
|
2825
|
+
description:
|
|
2826
|
+
description: Description of the category
|
|
2827
|
+
type: string
|
|
2828
|
+
hasSubCategories:
|
|
2829
|
+
description: HasSubCategories flag of the category
|
|
2830
|
+
type: boolean
|
|
2831
|
+
id:
|
|
2832
|
+
description: Id of the category
|
|
2833
|
+
type: string
|
|
2834
|
+
isNavigational:
|
|
2835
|
+
description: isNavigational of the category
|
|
2836
|
+
type: boolean
|
|
2837
|
+
name:
|
|
2838
|
+
description: Name of the category
|
|
2839
|
+
type: string
|
|
2840
|
+
parentCategoryId:
|
|
2841
|
+
description: Id of the parent category
|
|
2842
|
+
type: string
|
|
2843
|
+
sortOrder:
|
|
2844
|
+
description: Sort Order
|
|
2845
|
+
type: integer
|
|
2846
|
+
qualificationContext:
|
|
2847
|
+
description: Qualification Status of a Category
|
|
2848
|
+
type: QualificationContextOutputRepresentation
|
|
2849
|
+
required: false
|
|
2850
|
+
|
|
2851
|
+
CategoryListInputRepresentation:
|
|
2852
|
+
description: Input Representation for Category List.
|
|
2853
|
+
type: object
|
|
2854
|
+
properties:
|
|
2855
|
+
additionalContextData:
|
|
2856
|
+
description: Additional Context Data
|
|
2857
|
+
type: any
|
|
2858
|
+
required: false
|
|
2859
|
+
catalogId:
|
|
2860
|
+
description: Id of the catalog.
|
|
2861
|
+
type: string
|
|
2862
|
+
contextDefinition:
|
|
2863
|
+
description: Context Definition Name
|
|
2864
|
+
type: string
|
|
2865
|
+
required: false
|
|
2866
|
+
contextMapping:
|
|
2867
|
+
description: Context Mapping Name
|
|
2868
|
+
type: string
|
|
2869
|
+
required: false
|
|
2870
|
+
correlationId:
|
|
2871
|
+
description: CorrelationId
|
|
2872
|
+
type: string
|
|
2873
|
+
required: false
|
|
2874
|
+
customFields:
|
|
2875
|
+
description: Key value pair of custom fields
|
|
2876
|
+
type: array
|
|
2877
|
+
required: false
|
|
2878
|
+
items:
|
|
2879
|
+
type: string
|
|
2880
|
+
depth:
|
|
2881
|
+
description: Depth of the hierarchy
|
|
2882
|
+
type: integer
|
|
2883
|
+
required: false
|
|
2884
|
+
enableQualification:
|
|
2885
|
+
description: Enable Qualification
|
|
2886
|
+
type: boolean
|
|
2887
|
+
required: false
|
|
2888
|
+
usePromotions:
|
|
2889
|
+
description: Enable Promotion
|
|
2890
|
+
type: boolean
|
|
2891
|
+
required: false
|
|
2892
|
+
filter:
|
|
2893
|
+
description: Filter criteria
|
|
2894
|
+
type: FilterInputRepresentation
|
|
2895
|
+
required: false
|
|
2896
|
+
parentCategoryId:
|
|
2897
|
+
description: Parent Category Id
|
|
2898
|
+
type: string
|
|
2899
|
+
required: false
|
|
2900
|
+
qualificationProcedure:
|
|
2901
|
+
description: Qualification Procedure Name
|
|
2902
|
+
type: string
|
|
2903
|
+
required: false
|
|
2904
|
+
userContext:
|
|
2905
|
+
description: User context
|
|
2906
|
+
type: object
|
|
2907
|
+
required: false
|
|
2908
|
+
properties:
|
|
2909
|
+
//:
|
|
2910
|
+
type: any
|
|
2911
|
+
CategoryListOutputRepresentation:
|
|
2912
|
+
description: Category List output representation
|
|
2913
|
+
type: object
|
|
2914
|
+
properties:
|
|
2915
|
+
childCategories:
|
|
2916
|
+
description: Child Categories
|
|
2917
|
+
type: array
|
|
2918
|
+
items:
|
|
2919
|
+
type: CategoryDetailsOutputRepresentation
|
|
2920
|
+
catalogId:
|
|
2921
|
+
description: Id of the catalog the requested category belong to
|
|
2922
|
+
type: string
|
|
2923
|
+
customFields:
|
|
2924
|
+
description: Custom Fields
|
|
2925
|
+
type: object
|
|
2926
|
+
properties:
|
|
2927
|
+
//:
|
|
2928
|
+
type: any
|
|
2929
|
+
description:
|
|
2930
|
+
description: Description of the category
|
|
2931
|
+
type: string
|
|
2932
|
+
hasSubCategories:
|
|
2933
|
+
description: HasSubCategories flag of the category
|
|
2934
|
+
type: boolean
|
|
2935
|
+
id:
|
|
2936
|
+
description: Id of the category
|
|
2937
|
+
type: string
|
|
2938
|
+
isNavigational:
|
|
2939
|
+
description: isNavigational of the category
|
|
2940
|
+
type: boolean
|
|
2941
|
+
name:
|
|
2942
|
+
description: Name of the category
|
|
2943
|
+
type: string
|
|
2944
|
+
parentCategoryId:
|
|
2945
|
+
description: Id of the parent category
|
|
2946
|
+
type: string
|
|
2947
|
+
sortOrder:
|
|
2948
|
+
description: Sort Order
|
|
2949
|
+
type: integer
|
|
2950
|
+
qualificationContext:
|
|
2951
|
+
description: Qualification Status of a product
|
|
2952
|
+
type: QualificationContextOutputRepresentation
|
|
2953
|
+
required: false
|
|
2954
|
+
|
|
2955
|
+
CategoryOutputRepresentation:
|
|
2956
|
+
description: Category output representation
|
|
2957
|
+
type: object
|
|
2958
|
+
properties:
|
|
2959
|
+
catalogId:
|
|
2960
|
+
description: Id of the catalog the requested category belong to
|
|
2961
|
+
type: string
|
|
2962
|
+
customFields:
|
|
2963
|
+
description: Custom Fields
|
|
2964
|
+
type: object
|
|
2965
|
+
properties:
|
|
2966
|
+
//:
|
|
2967
|
+
type: any
|
|
2968
|
+
description:
|
|
2969
|
+
description: Description of the category
|
|
2970
|
+
type: string
|
|
2971
|
+
eligiblePromotions:
|
|
2972
|
+
description: List of eligiblePromotions for the product
|
|
2973
|
+
type: array
|
|
2974
|
+
items:
|
|
2975
|
+
type: PromotionOutputRepresentation
|
|
2976
|
+
hasSubCategories:
|
|
2977
|
+
description: HasSubCategories flag of the category
|
|
2978
|
+
type: boolean
|
|
2979
|
+
id:
|
|
2980
|
+
description: Id of the category
|
|
2981
|
+
type: string
|
|
2982
|
+
isNavigational:
|
|
2983
|
+
description: isNavigational of the category
|
|
2984
|
+
type: boolean
|
|
2985
|
+
name:
|
|
2986
|
+
description: Name of the category
|
|
2987
|
+
type: string
|
|
2988
|
+
parentCategoryId:
|
|
2989
|
+
description: Id of the parent category
|
|
2990
|
+
type: string
|
|
2991
|
+
sortOrder:
|
|
2992
|
+
description: Sort Order
|
|
2993
|
+
type: integer
|
|
2994
|
+
ProductPricesOutputRepresentation:
|
|
2995
|
+
description: Product Prices output representation
|
|
2996
|
+
type: object
|
|
2997
|
+
properties:
|
|
2998
|
+
currencyIsoCode:
|
|
2999
|
+
description: Currency ISO Code of the given price
|
|
3000
|
+
type: string
|
|
3001
|
+
required: false
|
|
3002
|
+
effectiveFrom:
|
|
3003
|
+
description: Effective From Date of the given price
|
|
3004
|
+
type: string
|
|
3005
|
+
required: false
|
|
3006
|
+
effectiveTo:
|
|
3007
|
+
description: Effective To Date of the given price
|
|
3008
|
+
type: string
|
|
3009
|
+
required: false
|
|
3010
|
+
price:
|
|
3011
|
+
description: Price
|
|
3012
|
+
format: double
|
|
3013
|
+
type: number
|
|
3014
|
+
required: false
|
|
3015
|
+
priceBookEntryId:
|
|
3016
|
+
description: Price book entry id of the given price
|
|
3017
|
+
type: string
|
|
3018
|
+
required: false
|
|
3019
|
+
priceBookId:
|
|
3020
|
+
description: Price book id of given price
|
|
3021
|
+
type: string
|
|
3022
|
+
required: false
|
|
3023
|
+
pricingModel:
|
|
3024
|
+
description: Pricing Model of the given price
|
|
3025
|
+
type: PricingModelOutputRepresentation
|
|
3026
|
+
required: false
|
|
3027
|
+
ProductQuantityOutputRepresentation:
|
|
3028
|
+
description: Product Quantity information output representation
|
|
3029
|
+
type: object
|
|
3030
|
+
properties:
|
|
3031
|
+
maxQuantity:
|
|
3032
|
+
description: Max Quantity allowed of a product
|
|
3033
|
+
format: double
|
|
3034
|
+
type: number
|
|
3035
|
+
required: false
|
|
3036
|
+
minQuantity:
|
|
3037
|
+
description: Min Quantity allowed of a product
|
|
3038
|
+
format: double
|
|
3039
|
+
type: number
|
|
3040
|
+
required: false
|
|
3041
|
+
quantity:
|
|
3042
|
+
description: Default Quantity allowed of a product
|
|
3043
|
+
format: double
|
|
3044
|
+
type: number
|
|
3045
|
+
required: false
|
|
3046
|
+
PriceCartInputRepresentationWrapper:
|
|
3047
|
+
description: Wrapper for Price Cart API
|
|
3048
|
+
type: object
|
|
3049
|
+
properties:
|
|
3050
|
+
requestBody:
|
|
3051
|
+
type: PriceCartInputRepresentation
|
|
3052
|
+
description: An Input Representation for Pricing Cart on demand
|
|
3053
|
+
PriceCartInputRepresentation:
|
|
3054
|
+
description: Input representation for price cart items API
|
|
3055
|
+
type: object
|
|
3056
|
+
properties:
|
|
3057
|
+
cartItemPricingConfig:
|
|
3058
|
+
description: Cart Item pricing configs
|
|
3059
|
+
type: array
|
|
3060
|
+
required: false
|
|
3061
|
+
items:
|
|
3062
|
+
type: object
|
|
3063
|
+
correlationId:
|
|
3064
|
+
description: Correlation Id
|
|
3065
|
+
required: false
|
|
3066
|
+
type: string
|
|
3067
|
+
userContext:
|
|
3068
|
+
description: User Context for cart pricing
|
|
3069
|
+
required: false
|
|
3070
|
+
type: object
|
|
3071
|
+
QocBaseOutputRepresentation:
|
|
3072
|
+
description: QOC Base output representation
|
|
3073
|
+
type: object
|
|
3074
|
+
properties:
|
|
3075
|
+
apiStatus:
|
|
3076
|
+
description: API Status
|
|
3077
|
+
type: ApiStatusOutputRepresentation
|
|
3078
|
+
SearchProductsInputRepresentation:
|
|
3079
|
+
description: Offers List input representation
|
|
3080
|
+
type: object
|
|
3081
|
+
properties:
|
|
3082
|
+
additionalFields:
|
|
3083
|
+
description: Map of additional fields
|
|
3084
|
+
type: object
|
|
3085
|
+
required: false
|
|
3086
|
+
catalogId:
|
|
3087
|
+
description: Id of the catalog.
|
|
3088
|
+
type: string
|
|
3089
|
+
required: false
|
|
3090
|
+
categoryId:
|
|
3091
|
+
description: Id of of the category.
|
|
3092
|
+
type: string
|
|
3093
|
+
required: false
|
|
3094
|
+
correlationId:
|
|
3095
|
+
description: CorrelationId
|
|
3096
|
+
type: string
|
|
3097
|
+
required: false
|
|
3098
|
+
limit:
|
|
3099
|
+
description: Number of item count you want in the response
|
|
3100
|
+
type: integer
|
|
3101
|
+
required: false
|
|
3102
|
+
offset:
|
|
3103
|
+
description: Offset size from which you need the item count
|
|
3104
|
+
type: integer
|
|
3105
|
+
required: false
|
|
3106
|
+
orderBy:
|
|
3107
|
+
description: Sort by ascending/descending order
|
|
3108
|
+
type: array
|
|
3109
|
+
required: false
|
|
3110
|
+
items:
|
|
3111
|
+
type: string
|
|
3112
|
+
priceBookId:
|
|
3113
|
+
description: Id of the price Book.
|
|
3114
|
+
type: string
|
|
3115
|
+
query:
|
|
3116
|
+
description: Search query
|
|
3117
|
+
type: any
|
|
3118
|
+
required: false
|
|
3119
|
+
searchTerm:
|
|
3120
|
+
description: Search Term
|
|
3121
|
+
type: string
|
|
3122
|
+
required: false
|
|
3123
|
+
userContext:
|
|
3124
|
+
description: User context in which cart would be created.
|
|
3125
|
+
type: object
|
|
3126
|
+
required: false
|
|
3127
|
+
filter:
|
|
3128
|
+
description: Filters
|
|
3129
|
+
type: object
|
|
3130
|
+
required: false
|
|
3131
|
+
usePromotions:
|
|
3132
|
+
description: Enable Promotions
|
|
3133
|
+
type: boolean
|
|
3134
|
+
required: false
|
|
3135
|
+
SearchProductsOutputRepresentation:
|
|
3136
|
+
description: Search Products output representation
|
|
3137
|
+
type: object
|
|
3138
|
+
properties:
|
|
3139
|
+
eligiblePromotions:
|
|
3140
|
+
description: List of promotions for the product
|
|
3141
|
+
type: array
|
|
3142
|
+
items:
|
|
3143
|
+
type: PromotionOutputRepresentation
|
|
3144
|
+
prices:
|
|
3145
|
+
description: List of prices of the product
|
|
3146
|
+
type: array
|
|
3147
|
+
required: false
|
|
3148
|
+
items:
|
|
3149
|
+
type: ProductPricesOutputRepresentation
|
|
3150
|
+
additionalFields:
|
|
3151
|
+
description: Map of additional fields
|
|
3152
|
+
type: object
|
|
3153
|
+
required: false
|
|
3154
|
+
attributeCategories:
|
|
3155
|
+
description: List of attribute categories in a product
|
|
3156
|
+
type: array
|
|
3157
|
+
required: false
|
|
3158
|
+
items:
|
|
3159
|
+
type: AttributeCategoryOutputRepresentation
|
|
3160
|
+
description:
|
|
3161
|
+
description: Description of the product
|
|
3162
|
+
type: string
|
|
3163
|
+
required: false
|
|
3164
|
+
id:
|
|
3165
|
+
description: Id of the product
|
|
3166
|
+
type: string
|
|
3167
|
+
required: false
|
|
3168
|
+
isComponentRequired:
|
|
3169
|
+
description: Is Component required of a product
|
|
3170
|
+
type: boolean
|
|
3171
|
+
required: false
|
|
3172
|
+
isDefaultComponent:
|
|
3173
|
+
description: Is the product a Default Component
|
|
3174
|
+
type: boolean
|
|
3175
|
+
required: false
|
|
3176
|
+
isQuantityEditable:
|
|
3177
|
+
description: Is Quantity of product editable
|
|
3178
|
+
type: boolean
|
|
3179
|
+
required: false
|
|
3180
|
+
name:
|
|
3181
|
+
description: Name of the product
|
|
3182
|
+
type: string
|
|
3183
|
+
required: false
|
|
3184
|
+
productQuantity:
|
|
3185
|
+
description: Quantity information of a product
|
|
3186
|
+
type: ProductQuantityOutputRepresentation
|
|
3187
|
+
required: false
|
|
3188
|
+
status:
|
|
3189
|
+
description: Status of the product
|
|
3190
|
+
type: string
|
|
3191
|
+
required: false
|
|
3192
|
+
SearchProductsFacetRepresentation:
|
|
3193
|
+
description: Search Products Facet Representation
|
|
3194
|
+
type: object
|
|
3195
|
+
properties:
|
|
3196
|
+
nameOrId:
|
|
3197
|
+
description: ID or internal name of the facet
|
|
3198
|
+
type: string
|
|
3199
|
+
required: false
|
|
3200
|
+
displayName:
|
|
3201
|
+
description: Display name of the facet
|
|
3202
|
+
type: string
|
|
3203
|
+
required: false
|
|
3204
|
+
displayRank:
|
|
3205
|
+
description: Display rank for the facet
|
|
3206
|
+
type: integer
|
|
3207
|
+
required: false
|
|
3208
|
+
attributeType:
|
|
3209
|
+
description: Search attribute type of the facet
|
|
3210
|
+
type: string
|
|
3211
|
+
required: false
|
|
3212
|
+
values:
|
|
3213
|
+
description: Face values of the facet found in the search result
|
|
3214
|
+
type: array
|
|
3215
|
+
required: false
|
|
3216
|
+
items:
|
|
3217
|
+
type: FacetValueRepresentation
|
|
3218
|
+
FacetValueRepresentation:
|
|
3219
|
+
description: Search Products Facet Value Representation
|
|
3220
|
+
type: object
|
|
3221
|
+
properties:
|
|
3222
|
+
nameOrId:
|
|
3223
|
+
description: ID or internal name of the facet value
|
|
3224
|
+
type: string
|
|
3225
|
+
required: false
|
|
3226
|
+
displayName:
|
|
3227
|
+
description: Display Name of the facet value
|
|
3228
|
+
type: string
|
|
3229
|
+
required: false
|
|
3230
|
+
FavoriteInputRepresentation:
|
|
3231
|
+
description: Favorite Input Representation
|
|
3232
|
+
type: object
|
|
3233
|
+
properties:
|
|
3234
|
+
data:
|
|
3235
|
+
description: data
|
|
3236
|
+
type: string
|
|
3237
|
+
description:
|
|
3238
|
+
description: description
|
|
3239
|
+
type: string
|
|
3240
|
+
name:
|
|
3241
|
+
description: name
|
|
3242
|
+
type: string
|
|
3243
|
+
referenceRecordId:
|
|
3244
|
+
description: referenceRecordId
|
|
3245
|
+
type: string
|
|
3246
|
+
FavoriteListOutputRepresenation:
|
|
3247
|
+
description: Favorite List Output Representation
|
|
3248
|
+
type: object
|
|
3249
|
+
properties:
|
|
3250
|
+
errors:
|
|
3251
|
+
description: List of Errors
|
|
3252
|
+
type: array
|
|
3253
|
+
items:
|
|
3254
|
+
type: object
|
|
3255
|
+
savedConfigurations:
|
|
3256
|
+
description: list of favorites
|
|
3257
|
+
type: array
|
|
3258
|
+
items:
|
|
3259
|
+
type: FavoriteOutputRepresenation
|
|
3260
|
+
success:
|
|
3261
|
+
description: success
|
|
3262
|
+
type: boolean
|
|
3263
|
+
FavoriteOutputRepresenation:
|
|
3264
|
+
description: Favorite Output Representation
|
|
3265
|
+
type: object
|
|
3266
|
+
properties:
|
|
3267
|
+
data:
|
|
3268
|
+
description: favorite data
|
|
3269
|
+
type: string
|
|
3270
|
+
description:
|
|
3271
|
+
description: favorite description
|
|
3272
|
+
type: string
|
|
3273
|
+
id:
|
|
3274
|
+
description: favorite id
|
|
3275
|
+
type: string
|
|
3276
|
+
name:
|
|
3277
|
+
description: favorite name
|
|
3278
|
+
type: string
|
|
3279
|
+
referenceRecordId:
|
|
3280
|
+
description: favorite referenceRecordId
|
|
3281
|
+
type: string
|
|
3282
|
+
ShareFavoriteInputRepresentation:
|
|
3283
|
+
description: Share Favorite Input Representation
|
|
3284
|
+
type: object
|
|
3285
|
+
properties:
|
|
3286
|
+
id:
|
|
3287
|
+
description: fav id
|
|
3288
|
+
type: string
|
|
3289
|
+
userId:
|
|
3290
|
+
description: user id
|
|
3291
|
+
type: string
|
|
3292
|
+
ShareFavoriteOutputRepresentation:
|
|
3293
|
+
description: Share Favorite Output Representation
|
|
3294
|
+
type: object
|
|
3295
|
+
properties:
|
|
3296
|
+
errors:
|
|
3297
|
+
description: List of Errors
|
|
3298
|
+
type: array
|
|
3299
|
+
items:
|
|
3300
|
+
type: any
|
|
3301
|
+
id:
|
|
3302
|
+
description: Share Favorite id
|
|
3303
|
+
type: string
|
|
3304
|
+
PreviewInputRepresentationWrapper:
|
|
3305
|
+
description: Preview Input Representation Wrapper
|
|
3306
|
+
type: object
|
|
3307
|
+
properties:
|
|
3308
|
+
previewInput:
|
|
3309
|
+
description: Key for api call
|
|
3310
|
+
type: PreviewInputRepresentation
|
|
3311
|
+
SearchProductsInputRepresentationWrapper:
|
|
3312
|
+
description: Search Products Input Representation Wrapper
|
|
3313
|
+
type: object
|
|
3314
|
+
properties:
|
|
3315
|
+
requestBody:
|
|
3316
|
+
description: Key for api call
|
|
3317
|
+
type: SearchProductsInputRepresentation
|
|
3318
|
+
ProductDetailsInputRepresentationWrapper:
|
|
3319
|
+
description: Product Details Input Representation Wrapper
|
|
3320
|
+
type: object
|
|
3321
|
+
properties:
|
|
3322
|
+
requestBody:
|
|
3323
|
+
description: Key for api call
|
|
3324
|
+
type: ProductDetailsInputRepresentation
|
|
3325
|
+
ProductListInputRepresentationWrapper:
|
|
3326
|
+
description: Product List Input Representation Wrapper
|
|
3327
|
+
type: object
|
|
3328
|
+
properties:
|
|
3329
|
+
requestBody:
|
|
3330
|
+
description: Key for api call
|
|
3331
|
+
type: ProductListInputRepresentation
|
|
3332
|
+
QualificationContextOutputRepresentation:
|
|
3333
|
+
description: QualificationContext Output Representation
|
|
3334
|
+
type: object
|
|
3335
|
+
properties:
|
|
3336
|
+
isQualified:
|
|
3337
|
+
description: is this product qualified
|
|
3338
|
+
type: boolean
|
|
3339
|
+
required: false
|
|
3340
|
+
reason:
|
|
3341
|
+
description: reason why the product is disqualified
|
|
3342
|
+
type: string
|
|
3343
|
+
required: false
|
|
3344
|
+
ProductSpecificationTypeOutputRepresentation:
|
|
3345
|
+
description: Product Specification Type Output Representation
|
|
3346
|
+
type: object
|
|
3347
|
+
properties:
|
|
3348
|
+
name:
|
|
3349
|
+
description: name of the specification
|
|
3350
|
+
type: string
|
|
3351
|
+
required: false
|
|
3352
|
+
productSpecificationRecordType:
|
|
3353
|
+
description: Record type of product specification
|
|
3354
|
+
type: ProductSpecificationRecordTypeOutputRepresentation
|
|
3355
|
+
required: false
|
|
3356
|
+
ProductSpecificationRecordTypeOutputRepresentation:
|
|
3357
|
+
description: Product Specification Record Type Output Representation
|
|
3358
|
+
type: object
|
|
3359
|
+
properties:
|
|
3360
|
+
isCommercial:
|
|
3361
|
+
description: is Commercial
|
|
3362
|
+
type: boolean
|
|
3363
|
+
required: false
|
|
3364
|
+
ProductClassificationOutputRepresentation:
|
|
3365
|
+
description: Product Classification Output Representation
|
|
3366
|
+
type: object
|
|
3367
|
+
properties:
|
|
3368
|
+
id:
|
|
3369
|
+
description: id of the product class
|
|
3370
|
+
type: string
|
|
3371
|
+
required: false
|
|
3372
|
+
ProductSellingModelOptionOutputRepresentation:
|
|
3373
|
+
description: Product Selling Model Option Output Representation
|
|
3374
|
+
type: object
|
|
3375
|
+
properties:
|
|
3376
|
+
id:
|
|
3377
|
+
description: id of the PSM option
|
|
3378
|
+
type: string
|
|
3379
|
+
required: false
|
|
3380
|
+
productSellingModelId:
|
|
3381
|
+
description: id of the PSM
|
|
3382
|
+
type: string
|
|
3383
|
+
required: false
|
|
3384
|
+
productId:
|
|
3385
|
+
description: id of the product
|
|
3386
|
+
type: string
|
|
3387
|
+
required: false
|
|
3388
|
+
productSellingModel:
|
|
3389
|
+
description: psm details
|
|
3390
|
+
type: ProductSellingModelOutputRepresentation
|
|
3391
|
+
required: false
|
|
3392
|
+
ProductSellingModelOutputRepresentation:
|
|
3393
|
+
description: Product Selling Model Output Representation
|
|
3394
|
+
type: object
|
|
3395
|
+
properties:
|
|
3396
|
+
id:
|
|
3397
|
+
description: id of the PSM
|
|
3398
|
+
type: string
|
|
3399
|
+
required: false
|
|
3400
|
+
name:
|
|
3401
|
+
description: name of the PSM
|
|
3402
|
+
type: string
|
|
3403
|
+
required: false
|
|
3404
|
+
sellingModelType:
|
|
3405
|
+
description: type of the PSM
|
|
3406
|
+
type: string
|
|
3407
|
+
required: false
|
|
3408
|
+
pricingTermUnit:
|
|
3409
|
+
description: term unit of the PSM
|
|
3410
|
+
type: string
|
|
3411
|
+
required: false
|
|
3412
|
+
status:
|
|
3413
|
+
description: status of the PSM
|
|
3414
|
+
type: string
|
|
3415
|
+
required: false
|
|
3416
|
+
pricingTerm:
|
|
3417
|
+
description: term of the PSM
|
|
3418
|
+
type: integer
|
|
3419
|
+
required: false
|
|
3420
|
+
ProductRelatedComponentOutputRepresentation:
|
|
3421
|
+
description: Product Related Component Output Representation
|
|
3422
|
+
type: object
|
|
3423
|
+
properties:
|
|
3424
|
+
id:
|
|
3425
|
+
description: if of the PRC
|
|
3426
|
+
type: string
|
|
3427
|
+
required: false
|
|
3428
|
+
childProductId:
|
|
3429
|
+
description: id of the child product
|
|
3430
|
+
type: string
|
|
3431
|
+
required: false
|
|
3432
|
+
parentProductId:
|
|
3433
|
+
description: id of the parent product
|
|
3434
|
+
type: string
|
|
3435
|
+
required: false
|
|
3436
|
+
productComponentGroupId:
|
|
3437
|
+
description: id of the PCG
|
|
3438
|
+
type: string
|
|
3439
|
+
required: false
|
|
3440
|
+
productClassificationId:
|
|
3441
|
+
description: id of the product class
|
|
3442
|
+
type: string
|
|
3443
|
+
required: false
|
|
3444
|
+
productRelationshipTypeId:
|
|
3445
|
+
description: id of the relationship type
|
|
3446
|
+
type: string
|
|
3447
|
+
required: false
|
|
3448
|
+
quantityScaleMethod:
|
|
3449
|
+
description: quantity Scale Method
|
|
3450
|
+
type: string
|
|
3451
|
+
required: false
|
|
3452
|
+
parentSellingModelId:
|
|
3453
|
+
description: id of the PSM
|
|
3454
|
+
type: string
|
|
3455
|
+
required: false
|
|
3456
|
+
childSellingModelId:
|
|
3457
|
+
description: id of the child selling model
|
|
3458
|
+
type: string
|
|
3459
|
+
required: false
|
|
3460
|
+
quantity:
|
|
3461
|
+
description: quantity
|
|
3462
|
+
format: double
|
|
3463
|
+
type: number
|
|
3464
|
+
required: false
|
|
3465
|
+
minQuantity:
|
|
3466
|
+
description: min quantity
|
|
3467
|
+
format: double
|
|
3468
|
+
type: number
|
|
3469
|
+
required: false
|
|
3470
|
+
maxQuantity:
|
|
3471
|
+
description: max quantity
|
|
3472
|
+
format: double
|
|
3473
|
+
type: number
|
|
3474
|
+
required: false
|
|
3475
|
+
sequence:
|
|
3476
|
+
description: sequence
|
|
3477
|
+
type: integer
|
|
3478
|
+
required: false
|
|
3479
|
+
isComponentRequired:
|
|
3480
|
+
description: is Component Required
|
|
3481
|
+
type: boolean
|
|
3482
|
+
required: false
|
|
3483
|
+
isDefaultComponent:
|
|
3484
|
+
description: is Default Component
|
|
3485
|
+
type: boolean
|
|
3486
|
+
required: false
|
|
3487
|
+
isQuantityEditable:
|
|
3488
|
+
description: is Quantity Editable
|
|
3489
|
+
type: boolean
|
|
3490
|
+
required: false
|
|
3491
|
+
doesBundlePriceIncludeChild:
|
|
3492
|
+
description: does Bundle Price Include Child
|
|
3493
|
+
type: boolean
|
|
3494
|
+
required: false
|
|
3495
|
+
quoteVisibility:
|
|
3496
|
+
description: Quote Visibility
|
|
3497
|
+
type: string
|
|
3498
|
+
required: false
|
|
3499
|
+
ProductComponentGroupOutputRepresentation:
|
|
3500
|
+
description: Product Component Group Output Representation
|
|
3501
|
+
type: object
|
|
3502
|
+
properties:
|
|
3503
|
+
id:
|
|
3504
|
+
description: id of the PCG
|
|
3505
|
+
type: string
|
|
3506
|
+
required: false
|
|
3507
|
+
name:
|
|
3508
|
+
description: name of the PCG
|
|
3509
|
+
type: string
|
|
3510
|
+
required: false
|
|
3511
|
+
description:
|
|
3512
|
+
description: description of the PCG
|
|
3513
|
+
type: string
|
|
3514
|
+
required: false
|
|
3515
|
+
parentProductId:
|
|
3516
|
+
description: id of the parent product
|
|
3517
|
+
type: string
|
|
3518
|
+
required: false
|
|
3519
|
+
minBundleComponents:
|
|
3520
|
+
description: minimum Bundle Components
|
|
3521
|
+
type: integer
|
|
3522
|
+
required: false
|
|
3523
|
+
maxBundleComponents:
|
|
3524
|
+
description: maximum Bundle Components
|
|
3525
|
+
type: integer
|
|
3526
|
+
required: false
|
|
3527
|
+
sequence:
|
|
3528
|
+
description: sequence
|
|
3529
|
+
type: integer
|
|
3530
|
+
required: false
|
|
3531
|
+
code:
|
|
3532
|
+
description: code of the PCG
|
|
3533
|
+
type: string
|
|
3534
|
+
required: false
|
|
3535
|
+
components:
|
|
3536
|
+
description: child products of the PCG
|
|
3537
|
+
type: array
|
|
3538
|
+
required: false
|
|
3539
|
+
items:
|
|
3540
|
+
type: ProductDetailsOutputRepresentation
|
|
3541
|
+
ResourceValueCollectionInputRepresentation:
|
|
3542
|
+
description: List of entity / attribute / tag values
|
|
3543
|
+
type: object
|
|
3544
|
+
properties:
|
|
3545
|
+
values:
|
|
3546
|
+
description: List of entity / attribute / tag values
|
|
3547
|
+
type: array
|
|
3548
|
+
required: false # TODO hand rolled. W-9275477
|
|
3549
|
+
items:
|
|
3550
|
+
type: string
|
|
3551
|
+
RuleActionCollectionInputRepresentation:
|
|
3552
|
+
description: Collection of rule actions
|
|
3553
|
+
type: object
|
|
3554
|
+
properties:
|
|
3555
|
+
ruleActions:
|
|
3556
|
+
description: List of rule actions
|
|
3557
|
+
type: array
|
|
3558
|
+
required: false # TODO hand rolled. W-9275477
|
|
3559
|
+
items:
|
|
3560
|
+
type: object
|
|
3561
|
+
RuleActionInputRepresentation:
|
|
3562
|
+
description: Input Representation for a single rule action
|
|
3563
|
+
type: object
|
|
3564
|
+
properties:
|
|
3565
|
+
actionParametersExpression:
|
|
3566
|
+
description: Conditional logic between action parameters
|
|
3567
|
+
type: string
|
|
3568
|
+
required: false # TODO hand rolled. W-9275477
|
|
3569
|
+
actionParameters:
|
|
3570
|
+
description: Condition defined on the attribute
|
|
3571
|
+
type: array
|
|
3572
|
+
required: false # TODO hand rolled. W-9275477
|
|
3573
|
+
items:
|
|
3574
|
+
type: object
|
|
3575
|
+
actionType:
|
|
3576
|
+
description: Action sub type of the rule
|
|
3577
|
+
type: string
|
|
3578
|
+
required: false # TODO hand rolled. W-9275477
|
|
3579
|
+
enum:
|
|
3580
|
+
- AutoAdd
|
|
3581
|
+
- AutoRemove
|
|
3582
|
+
- DisableAttributeValue
|
|
3583
|
+
- DisableProduct
|
|
3584
|
+
- Excludes
|
|
3585
|
+
- HideAttribute
|
|
3586
|
+
- HideAttributeValue
|
|
3587
|
+
- HideProduct
|
|
3588
|
+
- Requires
|
|
3589
|
+
- SetAttribute
|
|
3590
|
+
- SetDefaultAttributeValue
|
|
3591
|
+
- SetDefaultProduct
|
|
3592
|
+
- SetQuantity
|
|
3593
|
+
- Validate
|
|
3594
|
+
behaviorTypeLock:
|
|
3595
|
+
description: Behavior type of the target resource
|
|
3596
|
+
type: boolean
|
|
3597
|
+
required: false # TODO hand rolled. W-9275477
|
|
3598
|
+
message:
|
|
3599
|
+
description: Message to be displayed for a rule action
|
|
3600
|
+
type: string
|
|
3601
|
+
required: false # TODO hand rolled. W-9275477
|
|
3602
|
+
messageType:
|
|
3603
|
+
description: Message type
|
|
3604
|
+
type: string
|
|
3605
|
+
required: false # TODO hand rolled. W-9275477
|
|
3606
|
+
enum:
|
|
3607
|
+
- Error
|
|
3608
|
+
- Info
|
|
3609
|
+
- Warning
|
|
3610
|
+
name:
|
|
3611
|
+
description: Name of the action
|
|
3612
|
+
type: string
|
|
3613
|
+
required: false # TODO hand rolled. W-9275477
|
|
3614
|
+
sequence:
|
|
3615
|
+
description: Sequence for multiple actions
|
|
3616
|
+
type: integer
|
|
3617
|
+
required: false # TODO hand rolled. W-9275477
|
|
3618
|
+
targetContextTagName:
|
|
3619
|
+
description: Name of the action context tag resource
|
|
3620
|
+
type: string
|
|
3621
|
+
required: false # TODO hand rolled. W-9275477
|
|
3622
|
+
targetDataType:
|
|
3623
|
+
description: Data Type of the action context tag resource
|
|
3624
|
+
type: string
|
|
3625
|
+
required: false # TODO hand rolled. W-9275477
|
|
3626
|
+
enum:
|
|
3627
|
+
- Boolean
|
|
3628
|
+
- Currency
|
|
3629
|
+
- Date
|
|
3630
|
+
- DateTime
|
|
3631
|
+
- Integer
|
|
3632
|
+
- MultiPicklist
|
|
3633
|
+
- Number
|
|
3634
|
+
- Percent
|
|
3635
|
+
- Picklist
|
|
3636
|
+
- String
|
|
3637
|
+
- Text
|
|
3638
|
+
- Lookup
|
|
3639
|
+
targetInformation:
|
|
3640
|
+
description: Target information node
|
|
3641
|
+
type: array
|
|
3642
|
+
required: false # TODO hand rolled. W-9275477
|
|
3643
|
+
items:
|
|
3644
|
+
type: ConditionInformationInputRepresentation # TODO hand rolled. W-9275477
|
|
3645
|
+
targetOperator:
|
|
3646
|
+
description: Operator of the action context tag resource
|
|
3647
|
+
type: string
|
|
3648
|
+
required: false # TODO hand rolled. W-9275477
|
|
3649
|
+
enum:
|
|
3650
|
+
- Contains
|
|
3651
|
+
- DoesNotContain
|
|
3652
|
+
- Equals
|
|
3653
|
+
- GreaterThan
|
|
3654
|
+
- GreaterThanOrEquals
|
|
3655
|
+
- In
|
|
3656
|
+
- IsNotNull
|
|
3657
|
+
- IsNull
|
|
3658
|
+
- LessThan
|
|
3659
|
+
- LessThanOrEquals
|
|
3660
|
+
- NotEquals
|
|
3661
|
+
- NotIn
|
|
3662
|
+
targetValues:
|
|
3663
|
+
description: Value(s) of the action context tag resource
|
|
3664
|
+
type: array
|
|
3665
|
+
required: false # TODO hand rolled. W-9275477
|
|
3666
|
+
items:
|
|
3667
|
+
type: string
|
|
3668
|
+
RuleCriteriaCollectionInputRepresentation:
|
|
3669
|
+
description: Collection of rule criteria
|
|
3670
|
+
type: object
|
|
3671
|
+
properties:
|
|
3672
|
+
ruleCriteria:
|
|
3673
|
+
description: List of rule conditions
|
|
3674
|
+
type: array
|
|
3675
|
+
required: false # TODO hand rolled. W-9275477
|
|
3676
|
+
items:
|
|
3677
|
+
type: object
|
|
3678
|
+
RuleCriteriaInputRepresentation:
|
|
3679
|
+
description: Input Representation for a single rule condition
|
|
3680
|
+
type: object
|
|
3681
|
+
properties:
|
|
3682
|
+
conditionExpression:
|
|
3683
|
+
description: Conditional logic between the context and attribute conditions
|
|
3684
|
+
type: string
|
|
3685
|
+
required: false # TODO hand rolled. W-9275477
|
|
3686
|
+
conditions:
|
|
3687
|
+
description: Condition defined on the attribute
|
|
3688
|
+
type: array
|
|
3689
|
+
required: false # TODO hand rolled. W-9275477
|
|
3690
|
+
items:
|
|
3691
|
+
type: object
|
|
3692
|
+
criteriaIndex:
|
|
3693
|
+
description: Index of the condition
|
|
3694
|
+
type: integer
|
|
3695
|
+
required: false # TODO hand rolled. W-9275477
|
|
3696
|
+
rootObjectId:
|
|
3697
|
+
description: Entity Id of the Product / Transaction
|
|
3698
|
+
type: string | nil # TODO Hand-Rolled due to issue #1 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
|
|
3699
|
+
required: false # TODO hand rolled. W-9275477
|
|
3700
|
+
sourceContextTagName:
|
|
3701
|
+
description: Name of the condition context tag resource
|
|
3702
|
+
type: string
|
|
3703
|
+
required: false # TODO hand rolled. W-9275477
|
|
3704
|
+
sourceDataType:
|
|
3705
|
+
description: Data Type of the condition context tag resource
|
|
3706
|
+
type: string
|
|
3707
|
+
required: false # TODO hand rolled. W-9275477
|
|
3708
|
+
enum:
|
|
3709
|
+
- Boolean
|
|
3710
|
+
- Currency
|
|
3711
|
+
- Date
|
|
3712
|
+
- DateTime
|
|
3713
|
+
- Integer
|
|
3714
|
+
- MultiPicklist
|
|
3715
|
+
- Number
|
|
3716
|
+
- Percent
|
|
3717
|
+
- Picklist
|
|
3718
|
+
- String
|
|
3719
|
+
- Text
|
|
3720
|
+
- Lookup
|
|
3721
|
+
sourceInformation:
|
|
3722
|
+
description: Source information node
|
|
3723
|
+
type: array
|
|
3724
|
+
required: false # TODO hand rolled. W-9275477
|
|
3725
|
+
items:
|
|
3726
|
+
type: ConditionInformationInputRepresentation # TODO hand rolled. W-9275477
|
|
3727
|
+
sourceOperator:
|
|
3728
|
+
description: Operator of the condition context tag resource
|
|
3729
|
+
type: string
|
|
3730
|
+
required: false # TODO hand rolled. W-9275477
|
|
3731
|
+
enum:
|
|
3732
|
+
- Contains
|
|
3733
|
+
- DoesNotContain
|
|
3734
|
+
- Equals
|
|
3735
|
+
- GreaterThan
|
|
3736
|
+
- GreaterThanOrEquals
|
|
3737
|
+
- In
|
|
3738
|
+
- IsNotNull
|
|
3739
|
+
- IsNull
|
|
3740
|
+
- LessThan
|
|
3741
|
+
- LessThanOrEquals
|
|
3742
|
+
- NotEquals
|
|
3743
|
+
- NotIn
|
|
3744
|
+
sourceValues:
|
|
3745
|
+
description: Value(s) of the condition context tag resource
|
|
3746
|
+
type: array
|
|
3747
|
+
required: false # TODO hand rolled. W-9275477
|
|
3748
|
+
items:
|
|
3749
|
+
type: string
|
|
3750
|
+
UpdateCartInputRepresentationWrapper:
|
|
3751
|
+
description: Product List Input Representation Wrapper
|
|
3752
|
+
type: object
|
|
3753
|
+
properties:
|
|
3754
|
+
requestBody:
|
|
3755
|
+
description: Key for api call
|
|
3756
|
+
type: UpdateCartInputRepresentation
|
|
3757
|
+
UpdateCartInputRepresentation:
|
|
3758
|
+
description: Input Representation for Update Cart.
|
|
3759
|
+
type: object
|
|
3760
|
+
properties:
|
|
3761
|
+
actions:
|
|
3762
|
+
description: Actions
|
|
3763
|
+
type: array
|
|
3764
|
+
items:
|
|
3765
|
+
type: string
|
|
3766
|
+
enum:
|
|
3767
|
+
- Price
|
|
3768
|
+
- Validate
|
|
3769
|
+
correlationId:
|
|
3770
|
+
description: CorrelationId
|
|
3771
|
+
type: string
|
|
3772
|
+
required: false
|
|
3773
|
+
userContext:
|
|
3774
|
+
description: User context in which cart would be updated
|
|
3775
|
+
type: object
|
|
3776
|
+
required: false
|
|
3777
|
+
UpdateCartItemsInputRepresentationWrapper:
|
|
3778
|
+
description: Preview Input Representation Wrapper
|
|
3779
|
+
type: object
|
|
3780
|
+
properties:
|
|
3781
|
+
requestBody:
|
|
3782
|
+
description: Key for api call
|
|
3783
|
+
type: UpdateCartItemsInputRepresentation
|
|
3784
|
+
UpdateCartItemsInputRepresentation:
|
|
3785
|
+
description: Input Representation for update cart items API.
|
|
3786
|
+
type: object
|
|
3787
|
+
properties:
|
|
3788
|
+
cartItemConfigurations:
|
|
3789
|
+
description: A collection of updated cart item delta configurations.
|
|
3790
|
+
type: array
|
|
3791
|
+
required: false
|
|
3792
|
+
items:
|
|
3793
|
+
type: object
|
|
3794
|
+
correlationId:
|
|
3795
|
+
description: CorrelationId
|
|
3796
|
+
type: string
|
|
3797
|
+
required: false
|
|
3798
|
+
userContext:
|
|
3799
|
+
description: User context in which cart would be updated
|
|
3800
|
+
type: object
|
|
3801
|
+
required: false
|
|
3802
|
+
UpdateCartOutputRepresentation:
|
|
3803
|
+
description: Output Representation for Update cart.
|
|
3804
|
+
type: object
|
|
3805
|
+
properties:
|
|
3806
|
+
validationResults:
|
|
3807
|
+
description: Validation Results
|
|
3808
|
+
type: ValidateCartOutputRepresentation
|
|
3809
|
+
apiStatus:
|
|
3810
|
+
description: Api Status Object
|
|
3811
|
+
type: ApiStatusOutputRepresentation
|
|
3812
|
+
UpdateCartItemsOutputRepresentation:
|
|
3813
|
+
description: Output Representation for update cart items API.
|
|
3814
|
+
type: object
|
|
3815
|
+
properties:
|
|
3816
|
+
cartId:
|
|
3817
|
+
description: Id of the cart on which the update happened.
|
|
3818
|
+
required: false
|
|
3819
|
+
type: string
|
|
3820
|
+
apiStatus:
|
|
3821
|
+
description: API Status
|
|
3822
|
+
type: ApiStatusOutputRepresentation
|
|
3823
|
+
UpdateFavoriteInputRepresentation:
|
|
3824
|
+
description: Update Favorite Input Representation
|
|
3825
|
+
type: object
|
|
3826
|
+
properties:
|
|
3827
|
+
data:
|
|
3828
|
+
description: data
|
|
3829
|
+
type: string
|
|
3830
|
+
description:
|
|
3831
|
+
description: description
|
|
3832
|
+
type: string
|
|
3833
|
+
name:
|
|
3834
|
+
description: name
|
|
3835
|
+
type: string
|
|
3836
|
+
UpdateFavoriteOutputRepresentation:
|
|
3837
|
+
description: Create Favorite Output Representation
|
|
3838
|
+
type: object
|
|
3839
|
+
properties:
|
|
3840
|
+
errors:
|
|
3841
|
+
description: List of Errors
|
|
3842
|
+
type: array
|
|
3843
|
+
items:
|
|
3844
|
+
type: any
|
|
3845
|
+
success:
|
|
3846
|
+
description: success
|
|
3847
|
+
type: boolean
|
|
3848
|
+
ValidateCartOutputRepresentation:
|
|
3849
|
+
description: Output Representation for Validate cart API.
|
|
3850
|
+
type: object
|
|
3851
|
+
properties:
|
|
3852
|
+
attributeErrors:
|
|
3853
|
+
description: Attribute Errors
|
|
3854
|
+
type: array
|
|
3855
|
+
required: false
|
|
3856
|
+
items:
|
|
3857
|
+
type: ValidationResultOutputRepresentation
|
|
3858
|
+
breErrors:
|
|
3859
|
+
description: BRE Errors
|
|
3860
|
+
type: array
|
|
3861
|
+
required: false
|
|
3862
|
+
items:
|
|
3863
|
+
type: ValidationResultOutputRepresentation
|
|
3864
|
+
cardinalityErrors:
|
|
3865
|
+
description: Cardinality Errors
|
|
3866
|
+
type: array
|
|
3867
|
+
required: false
|
|
3868
|
+
items:
|
|
3869
|
+
type: ValidationResultOutputRepresentation
|
|
3870
|
+
hasErrors:
|
|
3871
|
+
description: Has Errors
|
|
3872
|
+
required: false
|
|
3873
|
+
type: boolean
|
|
3874
|
+
ValidationResultOutputRepresentation:
|
|
3875
|
+
description: Output representation for Validation Results
|
|
3876
|
+
type: object
|
|
3877
|
+
properties:
|
|
3878
|
+
cartItemId:
|
|
3879
|
+
description: Cart Item Id which couldn't pass validation
|
|
3880
|
+
required: false
|
|
3881
|
+
type: string
|
|
3882
|
+
condition:
|
|
3883
|
+
description: Validation Condition
|
|
3884
|
+
required: false
|
|
3885
|
+
type: string
|
|
3886
|
+
hasPassed:
|
|
3887
|
+
description: Flag to indicate whether validation has passed
|
|
3888
|
+
required: false
|
|
3889
|
+
type: boolean
|
|
3890
|
+
message:
|
|
3891
|
+
description: Validation failure message
|
|
3892
|
+
required: false
|
|
3893
|
+
type: string
|
|
3894
|
+
validationType:
|
|
3895
|
+
description: Validation Type
|
|
3896
|
+
required: false
|
|
3897
|
+
type: string
|
|
3898
|
+
RelatedObjectFilterInputRepresentation:
|
|
3899
|
+
description: Input Representation for Filters
|
|
3900
|
+
type: object
|
|
3901
|
+
properties:
|
|
3902
|
+
criteria:
|
|
3903
|
+
description: filter criteria
|
|
3904
|
+
type: array
|
|
3905
|
+
items:
|
|
3906
|
+
type: FilterCriteriaInputRepresentation
|
|
3907
|
+
objectName:
|
|
3908
|
+
description: Object Name
|
|
3909
|
+
type: string
|
|
3910
|
+
/connect/cpq:
|
|
3911
|
+
/preview:
|
|
3912
|
+
post:
|
|
3913
|
+
description: Preview product
|
|
3914
|
+
responses:
|
|
3915
|
+
'200':
|
|
3916
|
+
description: Success
|
|
3917
|
+
body:
|
|
3918
|
+
application/json:
|
|
3919
|
+
type: CpqBaseListOutputRepresentation
|
|
3920
|
+
body:
|
|
3921
|
+
application/json:
|
|
3922
|
+
type: PreviewInputRepresentationWrapper
|
|
3923
|
+
#required: false
|
|
3924
|
+
(oas-body-name): previewInput
|
|
3925
|
+
/products:
|
|
3926
|
+
post:
|
|
3927
|
+
displayName: postProductList
|
|
3928
|
+
description: Products List
|
|
3929
|
+
responses:
|
|
3930
|
+
'200':
|
|
3931
|
+
description: Success
|
|
3932
|
+
body:
|
|
3933
|
+
application/json:
|
|
3934
|
+
type: CpqBaseListOutputRepresentation
|
|
3935
|
+
body:
|
|
3936
|
+
application/json:
|
|
3937
|
+
type: ProductListInputRepresentationWrapper
|
|
3938
|
+
(oas-body-name): requestBody
|
|
3939
|
+
/guided-selection:
|
|
3940
|
+
post:
|
|
3941
|
+
displayName: guidedSelectionProductList
|
|
3942
|
+
description: Search for products as per guided selection criteria
|
|
3943
|
+
responses:
|
|
3944
|
+
'200':
|
|
3945
|
+
description: Success
|
|
3946
|
+
body:
|
|
3947
|
+
application/json:
|
|
3948
|
+
type: GuidedSelectionOutputRepresentation
|
|
3949
|
+
body:
|
|
3950
|
+
application/json:
|
|
3951
|
+
type: GuidedSelectionInputRepresentation
|
|
3952
|
+
(oas-body-name): requestBody
|
|
3953
|
+
/search:
|
|
3954
|
+
post:
|
|
3955
|
+
displayName: postSearchOffers
|
|
3956
|
+
description: Get products list based on search query
|
|
3957
|
+
responses:
|
|
3958
|
+
'200':
|
|
3959
|
+
description: Success
|
|
3960
|
+
body:
|
|
3961
|
+
application/json:
|
|
3962
|
+
type: CpqBaseListOutputRepresentation
|
|
3963
|
+
body:
|
|
3964
|
+
application/json:
|
|
3965
|
+
type: SearchProductsInputRepresentationWrapper
|
|
3966
|
+
(oas-body-name): requestBody
|
|
3967
|
+
/smart-selection:
|
|
3968
|
+
post:
|
|
3969
|
+
displayName: smartProductSelection
|
|
3970
|
+
description: Smart product selection
|
|
3971
|
+
responses:
|
|
3972
|
+
'200':
|
|
3973
|
+
description: Success
|
|
3974
|
+
body:
|
|
3975
|
+
application/json:
|
|
3976
|
+
type: SmartSelectionOutputRepresentation
|
|
3977
|
+
body:
|
|
3978
|
+
application/json:
|
|
3979
|
+
type: SmartSelectionInputRepresentation
|
|
3980
|
+
(oas-body-name): requestBody
|
|
3981
|
+
/bulk:
|
|
3982
|
+
post:
|
|
3983
|
+
displayName: postBulkProductDetails
|
|
3984
|
+
description: Bulk Product Details
|
|
3985
|
+
responses:
|
|
3986
|
+
'200':
|
|
3987
|
+
description: Success
|
|
3988
|
+
body:
|
|
3989
|
+
application/json:
|
|
3990
|
+
type: CpqBaseBulkDetailsOutput
|
|
3991
|
+
body:
|
|
3992
|
+
application/json:
|
|
3993
|
+
type: BulkProductDetailsInput
|
|
3994
|
+
(oas-body-name): requestBody
|
|
3995
|
+
/{productId}:
|
|
3996
|
+
post:
|
|
3997
|
+
displayName: postProductDetails
|
|
3998
|
+
description: Product Details
|
|
3999
|
+
responses:
|
|
4000
|
+
'200':
|
|
4001
|
+
description: Success
|
|
4002
|
+
body:
|
|
4003
|
+
application/json:
|
|
4004
|
+
type: CpqBaseDetailsOutputRepresentation
|
|
4005
|
+
body:
|
|
4006
|
+
application/json:
|
|
4007
|
+
type: ProductDetailsInputRepresentationWrapper
|
|
4008
|
+
(oas-body-name): requestBody
|
|
4009
|
+
uriParameters:
|
|
4010
|
+
productId:
|
|
4011
|
+
type: string
|
|
4012
|
+
required: true
|
|
4013
|
+
/categories:
|
|
4014
|
+
post:
|
|
4015
|
+
displayName: postCategoryList
|
|
4016
|
+
description: Category List
|
|
4017
|
+
responses:
|
|
4018
|
+
'200':
|
|
4019
|
+
description: Success
|
|
4020
|
+
body:
|
|
4021
|
+
application/json:
|
|
4022
|
+
type: CpqBaseListOutputRepresentation
|
|
4023
|
+
body:
|
|
4024
|
+
application/json:
|
|
4025
|
+
type: CategoryListInputRepresentation
|
|
4026
|
+
(oas-body-name): requestBody
|
|
4027
|
+
/categories/{categoryId}:
|
|
4028
|
+
post:
|
|
4029
|
+
displayName: postCategoryDetails
|
|
4030
|
+
description: Category Details
|
|
4031
|
+
responses:
|
|
4032
|
+
'200':
|
|
4033
|
+
description: Success
|
|
4034
|
+
body:
|
|
4035
|
+
application/json:
|
|
4036
|
+
type: CpqBaseDetailsOutputRepresentation
|
|
4037
|
+
body:
|
|
4038
|
+
application/json:
|
|
4039
|
+
type: CategoryDetailsInputRepresentation
|
|
4040
|
+
(oas-body-name): requestBody
|
|
4041
|
+
uriParameters:
|
|
4042
|
+
categoryId:
|
|
4043
|
+
type: string
|
|
4044
|
+
required: true
|
|
4045
|
+
/carts:
|
|
4046
|
+
post:
|
|
4047
|
+
displayName: createCart
|
|
4048
|
+
description: Create cart
|
|
4049
|
+
responses:
|
|
4050
|
+
'200':
|
|
4051
|
+
description: Success
|
|
4052
|
+
body:
|
|
4053
|
+
application/json:
|
|
4054
|
+
type: CreateCartOutputRepresentation
|
|
4055
|
+
body:
|
|
4056
|
+
application/json:
|
|
4057
|
+
type: CreateCartRequestWrapper
|
|
4058
|
+
(oas-body-name): createCartRequestPayload
|
|
4059
|
+
/carts/{cartId}:
|
|
4060
|
+
get:
|
|
4061
|
+
displayName: getCart
|
|
4062
|
+
description: Get Cart details with cart items
|
|
4063
|
+
responses:
|
|
4064
|
+
'200':
|
|
4065
|
+
description: Success
|
|
4066
|
+
body:
|
|
4067
|
+
application/json:
|
|
4068
|
+
type: GetCartOutputRepresentation
|
|
4069
|
+
patch:
|
|
4070
|
+
displayName: updateCart
|
|
4071
|
+
description: Update cart
|
|
4072
|
+
responses:
|
|
4073
|
+
'200':
|
|
4074
|
+
description: Success
|
|
4075
|
+
body:
|
|
4076
|
+
application/json:
|
|
4077
|
+
type: UpdateCartOutputRepresentation
|
|
4078
|
+
body:
|
|
4079
|
+
application/json:
|
|
4080
|
+
type: UpdateCartInputRepresentationWrapper
|
|
4081
|
+
(oas-body-name): requestBody
|
|
4082
|
+
uriParameters:
|
|
4083
|
+
cartId:
|
|
4084
|
+
type: string
|
|
4085
|
+
required: true
|
|
4086
|
+
/items:
|
|
4087
|
+
patch:
|
|
4088
|
+
displayName: updateCartItems
|
|
4089
|
+
description: Update cart items in an existing cart. Updating a cart item that
|
|
4090
|
+
does not exist in the given cart will lead to an error.
|
|
4091
|
+
responses:
|
|
4092
|
+
'200':
|
|
4093
|
+
description: Success
|
|
4094
|
+
body:
|
|
4095
|
+
application/json:
|
|
4096
|
+
type: UpdateCartItemsOutputRepresentation
|
|
4097
|
+
body:
|
|
4098
|
+
application/json:
|
|
4099
|
+
type: UpdateCartItemsInputRepresentationWrapper
|
|
4100
|
+
(oas-body-name): requestBody
|
|
4101
|
+
post:
|
|
4102
|
+
displayName: createCartItems
|
|
4103
|
+
description: Create cart items from products, and add it to a cart.
|
|
4104
|
+
responses:
|
|
4105
|
+
'200':
|
|
4106
|
+
description: Success
|
|
4107
|
+
body:
|
|
4108
|
+
application/json:
|
|
4109
|
+
type: CreateCartItemsOutputRepresentation
|
|
4110
|
+
body:
|
|
4111
|
+
application/json:
|
|
4112
|
+
type: CreateCartItemsInputRepresentationWrapper
|
|
4113
|
+
(oas-body-name): requestBody
|
|
4114
|
+
uriParameters:
|
|
4115
|
+
cartId:
|
|
4116
|
+
type: string
|
|
4117
|
+
required: true
|
|
4118
|
+
/price:
|
|
4119
|
+
patch:
|
|
4120
|
+
displayName: priceCart
|
|
4121
|
+
description: 'Runs Pricing for Cart '
|
|
4122
|
+
responses:
|
|
4123
|
+
'200':
|
|
4124
|
+
description: Success
|
|
4125
|
+
body:
|
|
4126
|
+
application/json:
|
|
4127
|
+
type: CartPricingTotalOutputRepresentation
|
|
4128
|
+
body:
|
|
4129
|
+
application/json:
|
|
4130
|
+
type: PriceCartInputRepresentationWrapper
|
|
4131
|
+
(oas-body-name): requestBody
|
|
4132
|
+
uriParameters:
|
|
4133
|
+
cartId:
|
|
4134
|
+
type: string
|
|
4135
|
+
required: true
|
|
4136
|
+
/configurator:
|
|
4137
|
+
/actions:
|
|
4138
|
+
/configure:
|
|
4139
|
+
post:
|
|
4140
|
+
displayName: postConfigurator
|
|
4141
|
+
description: Resource for the Configurator API
|
|
4142
|
+
responses:
|
|
4143
|
+
'200':
|
|
4144
|
+
description: Success
|
|
4145
|
+
body:
|
|
4146
|
+
application/json:
|
|
4147
|
+
type: ConfiguratorOutputRepresentation
|
|
4148
|
+
body: # TODO hand rolled. Removed 'required' attribute. W-9271732
|
|
4149
|
+
application/json:
|
|
4150
|
+
type: ConfiguratorInputRepresentationWrapper
|
|
4151
|
+
(oas-body-name): configuratorInput
|
|
4152
|
+
/create-rule:
|
|
4153
|
+
post:
|
|
4154
|
+
displayName: postConfiguratorRule
|
|
4155
|
+
description: Resource for the creation of config rules
|
|
4156
|
+
responses:
|
|
4157
|
+
'200':
|
|
4158
|
+
description: Success
|
|
4159
|
+
body:
|
|
4160
|
+
application/json:
|
|
4161
|
+
type: ConfiguratorRuleOutputRepresentation
|
|
4162
|
+
body:
|
|
4163
|
+
application/json:
|
|
4164
|
+
type: ConfiguratorRuleInputRepresentation
|
|
4165
|
+
#required: false # TODO handrolled W-13817376
|
|
4166
|
+
(oas-body-name): configRulesInput
|
|
4167
|
+
/update-rule:
|
|
4168
|
+
post:
|
|
4169
|
+
displayName: postUpdateRulesConfigurator
|
|
4170
|
+
description: Resource for the creation of config rules
|
|
4171
|
+
responses:
|
|
4172
|
+
'200':
|
|
4173
|
+
description: Success
|
|
4174
|
+
body:
|
|
4175
|
+
application/json:
|
|
4176
|
+
type: ConfiguratorRuleOutputRepresentation
|
|
4177
|
+
body:
|
|
4178
|
+
application/json:
|
|
4179
|
+
type: ConfiguratorRuleInputRepresentation
|
|
4180
|
+
#required: false # TODO handrolled W-13817376
|
|
4181
|
+
(oas-body-name): configRulesInput
|
|
4182
|
+
/validate-rule:
|
|
4183
|
+
post:
|
|
4184
|
+
displayName: postRulesValidator
|
|
4185
|
+
description: Resource method to validate a rule.
|
|
4186
|
+
responses:
|
|
4187
|
+
'200':
|
|
4188
|
+
description: Success
|
|
4189
|
+
body:
|
|
4190
|
+
application/json:
|
|
4191
|
+
type: ConfiguratorRuleValidatorOutputRepresentation
|
|
4192
|
+
body:
|
|
4193
|
+
application/json:
|
|
4194
|
+
type: ConfiguratorRuleValidatorInputRepresentation
|
|
4195
|
+
(oas-body-name): configRuleValidatorInput
|
|
4196
|
+
/saved-configuration:
|
|
4197
|
+
get:
|
|
4198
|
+
displayName: getFavorite
|
|
4199
|
+
description: API to fetch list of favorites.
|
|
4200
|
+
responses:
|
|
4201
|
+
'200':
|
|
4202
|
+
description: Success
|
|
4203
|
+
body:
|
|
4204
|
+
application/json:
|
|
4205
|
+
type: FavoriteListOutputRepresenation
|
|
4206
|
+
queryParameters:
|
|
4207
|
+
referenceRecordId:
|
|
4208
|
+
type: string
|
|
4209
|
+
post:
|
|
4210
|
+
displayName: createFavorite
|
|
4211
|
+
description: API to create favorite
|
|
4212
|
+
responses:
|
|
4213
|
+
'200':
|
|
4214
|
+
description: Success
|
|
4215
|
+
body:
|
|
4216
|
+
application/json:
|
|
4217
|
+
type: CreateFavoriteOutputRepresentation
|
|
4218
|
+
body:
|
|
4219
|
+
application/json:
|
|
4220
|
+
type: FavoriteInputRepresentation
|
|
4221
|
+
(oas-body-name): createFavoritePayload
|
|
4222
|
+
/saved-configuration/{id}:
|
|
4223
|
+
# added get to comply with compiler warning: DELETE resource with key annotation has no sibling GET resource. DELETE resource keys must match GET response keys at the same path
|
|
4224
|
+
get:
|
|
4225
|
+
description: API to fetch favorite.
|
|
4226
|
+
responses:
|
|
4227
|
+
'200':
|
|
4228
|
+
description: Success
|
|
4229
|
+
body:
|
|
4230
|
+
application/json:
|
|
4231
|
+
type: FavoriteOutputRepresenation
|
|
4232
|
+
delete:
|
|
4233
|
+
displayName: deleteFavorite
|
|
4234
|
+
description: API to delete favorite
|
|
4235
|
+
responses:
|
|
4236
|
+
'200':
|
|
4237
|
+
description: Success
|
|
4238
|
+
put:
|
|
4239
|
+
displayName: updateFavorite
|
|
4240
|
+
description: API to update favorite
|
|
4241
|
+
responses:
|
|
4242
|
+
'200':
|
|
4243
|
+
description: Success
|
|
4244
|
+
body:
|
|
4245
|
+
application/json:
|
|
4246
|
+
type: UpdateFavoriteOutputRepresentation
|
|
4247
|
+
body:
|
|
4248
|
+
application/json:
|
|
4249
|
+
type: UpdateFavoriteInputRepresentation
|
|
4250
|
+
(oas-body-name): updateFavoritePayload
|
|
4251
|
+
uriParameters:
|
|
4252
|
+
id:
|
|
4253
|
+
description: Favorite Id on which the operation has to be performed.
|
|
4254
|
+
type: string
|
|
4255
|
+
required: true
|
|
4256
|
+
/favorite/actions/share:
|
|
4257
|
+
post:
|
|
4258
|
+
displayName: shareFavorite
|
|
4259
|
+
description: API to share favorite
|
|
4260
|
+
responses:
|
|
4261
|
+
'200':
|
|
4262
|
+
description: Success
|
|
4263
|
+
body:
|
|
4264
|
+
application/json:
|
|
4265
|
+
type: ShareFavoriteOutputRepresentation
|
|
4266
|
+
body:
|
|
4267
|
+
application/json:
|
|
4268
|
+
type: ShareFavoriteInputRepresentation
|
|
4269
|
+
(oas-body-name): shareFavoritePayload
|