Product (1.0)
Download OpenAPI specification:Download
API to manage products
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string Example: target=lastUpdateReason,nextGenerationOf Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
customerId | string Example: customerId=d775dd4f-458e-4493-bfec-fb4a23901580 Filter products by customerId |
lifeTime | string Example: lifeTime=PERMANENT Filter products by subscription lifetime |
subscriptionTemplate | string Example: subscriptionTemplate=NEXWAY_1M Filter products by subscription template |
parentId | string Example: parentId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by parentId |
productFamily | string Example: productFamily=My Product Family Name Filter products by product family |
physical | boolean Example: physical=true Filter physical products |
publisherRefId | string Example: publisherRefId=myPublisherRefId Filter products by publisher reference ID |
salesMode | string Example: salesMode=STANDARD Filter products by sales mode |
fulfillmentTemplate | string Example: fulfillmentTemplate=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by fulfillment template name |
type | string Example: type=SOFTWARE Filter products by product type |
catalogId | string Example: catalogId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by catalog ID |
descriptionId | string Example: descriptionId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by description ID |
codeName | string Example: codeName=myCodeName Filter products by code name |
genericName | string Example: genericName=myGenericName Filter products by generic name of the product |
priceFunction | string Example: priceFunction=e3266efa-7cbf-447c-bd53-4a765a0b494e Filter products by price function ID |
sellingStores | string Example: sellingStores=e3266efa-7cbf-447c-bd53-4a765a0b494e,29c46780-a263-4694-bb9e-286152e688b7 Filter products by availability in stores, may be multiple occurrences of this param |
status | string Example: status=ENABLED Filter products by status (ENABLED/DISABLED) |
blackListedCountries | string Example: blackListedCountries=FR,DE Filter products blacklisted in specific country, may be multiple occurrences of this param |
releaseDate | string <date-time> Example: releaseDate=1668456000 Planned product release date |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
object (ActivationLink) Activation link | |
Array of objects (Variable) Available product variables | |
blackListedCountries | Array of strings unique List of countries not authorized for this product |
businessSegment | string Enum: "B2C" "B2B" "STRICT_B2C" "STRICT_B2B" Business segment. Describe who you intend to sell this product. |
catalogId | string Catalog ID |
codeName | string Code name of product |
createDate | string <date-time> Deprecated |
customFieldsId | string CustomFields ID |
customerId | string |
dbVersion | integer <int64> |
defaultLocale | string Default locale of the product |
descriptionId | string Description ID |
externalContext | string External context |
forcedCrossSaleProductIds | Array of strings unique List of forced cross-sales product IDs |
fulfillmentTemplate | string Fulfillment template name or id depending on the fulfillment version |
fulfillmentTemplateName | string Fulfillment template name |
genericName | string Name of product |
id | string Deprecated |
lastUpdateReason | string |
lifeTime required | string^(((?<duration>[0-9]*)(?<period>MONTH|YEAR|DA... lifeTime |
object List of localized long descriptions of the product | |
object List of localized short descriptions of the product | |
object List of localized thank you descriptions of the product | |
object List of localized marketing names of the product | |
modelVersion | string Deprecated |
nextGenerationOf | Array of strings unique List of old generation IDs |
originalId | string |
paidTrial | boolean Flag for paid trial product |
physical | boolean How do we deliver product : physical/digital |
priceFunction | string Price function ID |
required | object (Prices) Price of product by currency and country |
productFamily | string [ 0 .. 128 ] characters Product family |
publisherProductId | string |
publisherRefId required | string [ 0 .. 80 ] characters Product publisher reference |
Array of objects (RelatedContent) Links for downloading product-related content file | |
releaseDate | string <date-time> Planned product release date |
Array of objects (Resource) unique Product resources | |
salesMode | string Enum: "BILLING_PLAN" "STANDARD" Sales mode |
sellingStores required | Array of strings unique List of stores selling this product |
signedProduct | string |
subProducts | Array of strings List of sub-product IDs |
subscriptionTemplate | string Subscription template name |
taxCode | string Avatax tax code |
trialAllowed | boolean Flag for subscription trial allowed on this product |
trialDuration | integer <int32> Duration of subscription trial on this product (in days) |
type | string Enum: "SOFTWARE" "GAMES" "CASUAL" "SERVICE" "B2C" "B2B" "HARDWARE" Product type |
unifiedRegisterSoftware | boolean Indicator if Product is included in unified register |
updateDate | string <date-time> Deprecated |
var | string |
variantOf | string |
object Visual tags linked to product |
Responses
Request samples
- Payload
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultLocale": "string",
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "marketingName": {
- "property1": "string",
- "property2": "string"
}, - "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "originalId": "string",
- "paidTrial": true,
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "var": "string",
- "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get the default currencies of products
Get the default currencies for the given products ids
Authorizations:
query Parameters
productId required | string Example: productId=productId1,productId2,productId3 List of product id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
"string"
Duplicate a product, if the product has variants it will also duplicate all variants
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
object (ProductDuplicationOptions) | |
productName required | string Product name of the new product |
publisherRefId required | string Publisher reference ID of the new product |
Responses
Request samples
- Payload
{- "duplicationOptions": {
- "duplicateFulfillment": true,
- "duplicateGeneral": true,
- "duplicateLocalizedContent": true,
- "duplicatePrices": true,
- "duplicateProductFiles": true,
- "duplicateProductVariations": true,
- "duplicateSubscription": true
}, - "productName": "My Product",
- "publisherRefId": "49FD453"
}
Response samples
- 200
- 400
- 404
- 500
{- "id": "3584f058-fd8a-439e-be21-126a0b16c128"
}
Update all products fulfillment templates of a specific customer
Authorizations:
Request Body schema: application/jsonrequired
customerId required | string Customer ID |
fulfillmentTemplateIdTarget required | string ID of the fulfillment template to change in products |
fulfillmentTemplateSource required | string Source is the fulfillment template name or id depending on the fulfillment version - name for fulfillment v0 or id for fulfillment v1 |
Responses
Request samples
- Payload
{- "customerId": "string",
- "fulfillmentTemplateIdTarget": "string",
- "fulfillmentTemplateSource": "string"
}
Response samples
- 200
- 400
- 404
- 500
"string"
Import a product
Import a product
Authorizations:
query Parameters
locale | string |
storeId | string Example: storeId=5a095a54-445c-4b57-ba6d-23fdc63df4c9 Store id |
dryRun | boolean Example: dryRun=true Determine if the operation will take effect in the database, if dryRun is true, product will not be import |
reason | string Example: reason=Import from old version to new version Request reason |
local | string Example: local=fr-FR Local of product |
Request Body schema: application/jsonrequired
Product to be import
Responses
Request samples
- Payload
"string"
Response samples
- 200
- 201
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
object (ActivationLink) Activation link | |
Array of objects (Variable) Available product variables | |
blackListedCountries | Array of strings unique List of countries not authorized for this product |
businessSegment | string Enum: "B2C" "B2B" "STRICT_B2C" "STRICT_B2B" Business segment. Describe who you intend to sell this product. |
catalogId | string Catalog ID |
codeName | string Code name of product |
createDate | string <date-time> Deprecated |
customFieldsId | string CustomFields ID |
customerId | string |
dbVersion | integer <int64> |
defaultLocale | string Default locale of the product |
descriptionId | string Description ID |
externalContext | string External context |
forcedCrossSaleProductIds | Array of strings unique List of forced cross-sales product IDs |
fulfillmentTemplate | string Fulfillment template name or id depending on the fulfillment version |
fulfillmentTemplateName | string Fulfillment template name |
genericName | string Name of product |
id | string Deprecated |
lastUpdateReason | string |
lifeTime required | string^(((?<duration>[0-9]*)(?<period>MONTH|YEAR|DA... lifeTime |
object List of localized long descriptions of the product | |
object List of localized short descriptions of the product | |
object List of localized thank you descriptions of the product | |
object List of localized marketing names of the product | |
modelVersion | string Deprecated |
nextGenerationOf | Array of strings unique List of old generation IDs |
originalId | string |
paidTrial | boolean Flag for paid trial product |
physical | boolean How do we deliver product : physical/digital |
priceFunction | string Price function ID |
required | object (Prices) Price of product by currency and country |
productFamily | string [ 0 .. 128 ] characters Product family |
publisherProductId | string |
publisherRefId required | string [ 0 .. 80 ] characters Product publisher reference |
Array of objects (RelatedContent) Links for downloading product-related content file | |
releaseDate | string <date-time> Planned product release date |
Array of objects (Resource) unique Product resources | |
salesMode | string Enum: "BILLING_PLAN" "STANDARD" Sales mode |
sellingStores required | Array of strings unique List of stores selling this product |
signedProduct | string |
subProducts | Array of strings List of sub-product IDs |
subscriptionTemplate | string Subscription template name |
taxCode | string Avatax tax code |
trialAllowed | boolean Flag for subscription trial allowed on this product |
trialDuration | integer <int32> Duration of subscription trial on this product (in days) |
type | string Enum: "SOFTWARE" "GAMES" "CASUAL" "SERVICE" "B2C" "B2B" "HARDWARE" Product type |
unifiedRegisterSoftware | boolean Indicator if Product is included in unified register |
updateDate | string <date-time> Deprecated |
var | string |
variantOf | string |
object Visual tags linked to product |
Responses
Request samples
- Payload
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultLocale": "string",
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "marketingName": {
- "property1": "string",
- "property2": "string"
}, - "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "originalId": "string",
- "paidTrial": true,
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "var": "string",
- "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get the next generation of Product
Get the next generation of product according to the given product id
Authorizations:
path Parameters
id required | string Example: 0966f613-5c17-4a7a-b1eb-1114164bc601 Product id |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Update product without updating prices
Be able to update the product without price information for the given product id
Authorizations:
path Parameters
id required | string Example: e1c2705a-58e0-4b9c-8d74-063521055a09 Existing product id |
Request Body schema: application/jsonrequired
object (ActivationLink) Activation link | |
Array of objects (Variable) Available product variables | |
blackListedCountries | Array of strings unique List of countries not authorized for this product |
businessSegment | string Enum: "B2C" "B2B" "STRICT_B2C" "STRICT_B2B" Business segment. Describe who you intend to sell this product. |
catalogId | string Catalog ID |
codeName | string Code name of product |
createDate | string <date-time> Deprecated |
customFieldsId | string CustomFields ID |
customerId | string |
dbVersion | integer <int64> |
defaultLocale | string Default locale of the product |
descriptionId | string Description ID |
externalContext | string External context |
forcedCrossSaleProductIds | Array of strings unique List of forced cross-sales product IDs |
fulfillmentTemplate | string Fulfillment template name or id depending on the fulfillment version |
fulfillmentTemplateName | string Fulfillment template name |
genericName | string Name of product |
id | string Deprecated |
lastUpdateReason | string |
lifeTime required | string^(((?<duration>[0-9]*)(?<period>MONTH|YEAR|DA... lifeTime |
object List of localized long descriptions of the product | |
object List of localized short descriptions of the product | |
object List of localized thank you descriptions of the product | |
object List of localized marketing names of the product | |
modelVersion | string Deprecated |
nextGenerationOf | Array of strings unique List of old generation IDs |
originalId | string |
paidTrial | boolean Flag for paid trial product |
physical | boolean How do we deliver product : physical/digital |
priceFunction | string Price function ID |
required | object (Prices) Price of product by currency and country |
productFamily | string [ 0 .. 128 ] characters Product family |
publisherProductId | string |
publisherRefId required | string [ 0 .. 80 ] characters Product publisher reference |
Array of objects (RelatedContent) Links for downloading product-related content file | |
releaseDate | string <date-time> Planned product release date |
Array of objects (Resource) unique Product resources | |
salesMode | string Enum: "BILLING_PLAN" "STANDARD" Sales mode |
sellingStores required | Array of strings unique List of stores selling this product |
signedProduct | string |
subProducts | Array of strings List of sub-product IDs |
subscriptionTemplate | string Subscription template name |
taxCode | string Avatax tax code |
trialAllowed | boolean Flag for subscription trial allowed on this product |
trialDuration | integer <int32> Duration of subscription trial on this product (in days) |
type | string Enum: "SOFTWARE" "GAMES" "CASUAL" "SERVICE" "B2C" "B2B" "HARDWARE" Product type |
unifiedRegisterSoftware | boolean Indicator if Product is included in unified register |
updateDate | string <date-time> Deprecated |
var | string |
variantOf | string |
object Visual tags linked to product |
Responses
Request samples
- Payload
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultLocale": "string",
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "marketingName": {
- "property1": "string",
- "property2": "string"
}, - "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "originalId": "string",
- "paidTrial": true,
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "var": "string",
- "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "availableVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "codeName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "descriptionId": "string",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "genericName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "priceFunction": "string",
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "signedProduct": "string",
- "status": "ENABLED",
- "subProducts": [
- "string"
], - "subscriptionTemplate": "string",
- "taxCode": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "updateDate": "2019-08-24T14:15:22Z",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get variant matrix
Get matrix of all available product variants
Authorizations:
path Parameters
id required | string Example: 2b760279-a875-411d-9ebf-d90bfeb40c95 Product id |
query Parameters
predicate required | object |
format | string^|1D|ND|(\[[A-Za-z0-9,]+])+$ Examples:
In which format that the variables in the matrix will be organized. Prefix and suffix are |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "format": "string",
- "matrix": { },
- "matrixVariables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
]
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
catalogId | string Catalog ID |
createDate | string <date-time> Deprecated |
object | |
customerId | string |
dbVersion | integer <int64> |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
originalId | string |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "originalId": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
catalogId | string Catalog ID |
createDate | string <date-time> Deprecated |
object | |
customerId | string |
dbVersion | integer <int64> |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
originalId | string |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "originalId": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customerId": "string",
- "dbVersion": 0,
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "updateDate": "2019-08-24T14:15:22Z"
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
description | string Custom field description |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
name | string Custom field name |
originalId | string |
type | string Enum: "LOCALIZED_TEXT" "INTEGER" "BOOLEAN" Custom field type |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "originalId": "string",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
description | string Custom field description |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
name | string Custom field name |
originalId | string |
type | string Enum: "LOCALIZED_TEXT" "INTEGER" "BOOLEAN" Custom field type |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "originalId": "string",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "VPN product",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "vpnIncludedFeature",
- "type": "LOCALIZED_TEXT, INTEGER, BOOLEAN",
- "updateDate": "2019-08-24T14:15:22Z"
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string Example: target=customerId,lifeTime,trialAllowed,type,... Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
customerId | string Example: customerId=3d772d1c-853e-4f51-bd6e-24562708ab3f Filter products by customer ID |
catalogId | string Example: catalogId=5a10f260-83e8-4b7f-9a58-3b67f0ed5d8d Filter products by catalog ID |
productId | string Example: productId=5a10f260-83e8-4b7f-9a58-3b67f0ed5d8d Filter products by product ID |
sellingStore | string Example: sellingStore=mySellingStoreName Filter products by availability in stores, may be multiple occurrences of this param |
subscriptionTemplate | string Example: subscriptionTemplate=82c9cd93-ced4-4603-b51f-7ef8aa8ab40b Filter products by subscription template |
fulfillmentTemplate | string Example: fulfillmentTemplate=myFulfillmentName Filter products by fulfillment template name |
status | boolean Example: status=true Filter products by status (ENABLED/DISABLED) |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
catalogId | string Optional catalog ID |
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
fulfillmentTemplate | string Fulfillment template name |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
originalId | string |
paidTrial | boolean Indicator if it is a paid trial product |
object (Prices) Price of product by currency and country | |
productId required | string Product ID of merchant |
sellingStores | Array of strings List of stores selling this product |
status | string Enum: "ENABLED" "DISABLED" Product status |
subscriptionTemplate | string Subscription template name |
trialAllowed | boolean Indicator if subscription trial is allowed on this product |
trialDuration | integer <int32> Duration of subscription trial on this product (in days) |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "originalId": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
catalogId | string Optional catalog ID |
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
fulfillmentTemplate | string Fulfillment template name |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
originalId | string |
paidTrial | boolean Indicator if it is a paid trial product |
object (Prices) Price of product by currency and country | |
productId required | string Product ID of merchant |
sellingStores | Array of strings List of stores selling this product |
status | string Enum: "ENABLED" "DISABLED" Product status |
subscriptionTemplate | string Subscription template name |
trialAllowed | boolean Indicator if subscription trial is allowed on this product |
trialDuration | integer <int32> Duration of subscription trial on this product (in days) |
updateDate | string <date-time> Deprecated |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "originalId": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "fulfillmentTemplate": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "paidTrial": true,
- "prices": {
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "priceByCountryByCurrency": {
- "property1": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}, - "property2": {
- "property1": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}, - "property2": {
- "crossSell": 0.1,
- "initialValue": 0.1,
- "msrp": 0.1,
- "upSell": 0.1,
- "value": 0.1,
- "vatIncluded": true
}
}
}
}, - "productId": "string",
- "sellingStores": [
- "string"
], - "status": "ENABLED",
- "subscriptionTemplate": "string",
- "trialAllowed": true,
- "trialDuration": 0,
- "updateDate": "2019-08-24T14:15:22Z"
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string Example: target=marketingName,fallbackLocale,localizedMarketingName,... Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
customerId | string Example: customerId=81163a60-abcd-4ee6-9a31-c8385b6119ea Filter descriptions by customerId |
catalogId | string Example: catalogId=26a1f350-64cd-4b98-a05e-fc0035359ffa Filter descriptions by catalogId |
fallbackLocale | string Example: fallbackLocale=en-US Filter descriptions by fallback locale |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
catalogId | string Catalog ID |
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
description required | string Description's comment |
fallbackLocale | string Fallback locale |
id | string Deprecated |
lastUpdateReason | string |
object Localized long descriptions | |
object Localized manual Renewal email descriptions | |
required | object Localized marketing name descriptions |
object Localized purchase email descriptions | |
object Localized short descriptions | |
object Localized subscription email descriptions | |
object Localized thank you page descriptions | |
modelVersion | string Deprecated |
originalId | string |
updateDate | string <date-time> Deprecated |
Array of objects (VariableDescription) Variable Descriptions |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "modelVersion": "string",
- "originalId": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search descriptions with text
Search descriptions with text
Authorizations:
query Parameters
required | object (Pageable) Example: pageable=size=150&page=0 Pageable parameters |
req required | string Example: req=aTextToSearchWith A text in the description to search with |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
{- "items": [
- {
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
catalogId | string Catalog ID |
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
description required | string Description's comment |
fallbackLocale | string Fallback locale |
id | string Deprecated |
lastUpdateReason | string |
object Localized long descriptions | |
object Localized manual Renewal email descriptions | |
required | object Localized marketing name descriptions |
object Localized purchase email descriptions | |
object Localized short descriptions | |
object Localized subscription email descriptions | |
object Localized thank you page descriptions | |
modelVersion | string Deprecated |
originalId | string |
updateDate | string <date-time> Deprecated |
Array of objects (VariableDescription) Variable Descriptions |
Responses
Request samples
- Payload
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "modelVersion": "string",
- "originalId": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string Example: target=name,parameters,productFields,... Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
customerId | string Example: customerId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter price functions by customerId |
name | string Example: name=myPriceFunctionName Filter price functions by name |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Create an item
Authorizations:
Request Body schema: application/jsonrequired
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
expression required | string JEXL expression for price function |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
name required | string Name of the price function |
originalId | string |
Array of objects (Parameter) Parameters of the expression | |
productFields | Array of strings unique Product fields used in the expression |
updateDate | string <date-time> Deprecated |
variables | Array of strings unique Variables used in the expression |
Responses
Request samples
- Payload
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "originalId": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Response samples
- 201
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Duplicate a price function
Duplicate a price function of given price function id to the customer of the given customer id
Authorizations:
path Parameters
customerId required | string Example: 1a45d839-9c0f-4691-8b79-1d2b4797fe8d Customer id to duplicate in |
id required | string Example: 5ccdd01d-3a93-4fa6-b251-9434b9ca35ad Price function id |
Responses
Response samples
- 200
- 201
- 400
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Get recap quantities for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Search unwind for a given field
Authorizations:
query Parameters
target required | string |
required | object (Pageable) |
predicate required | object |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "empty": true,
- "property1": { },
- "property2": { }
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Update item
Authorizations:
path Parameters
id required | string |
Request Body schema: application/jsonrequired
createDate | string <date-time> Deprecated |
customerId | string |
dbVersion | integer <int64> |
expression required | string JEXL expression for price function |
id | string Deprecated |
lastUpdateReason | string |
modelVersion | string Deprecated |
name required | string Name of the price function |
originalId | string |
Array of objects (Parameter) Parameters of the expression | |
productFields | Array of strings unique Product fields used in the expression |
updateDate | string <date-time> Deprecated |
variables | Array of strings unique Variables used in the expression |
Responses
Request samples
- Payload
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "originalId": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "expression": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "parameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "productFields": [
- "string"
], - "updateDate": "2019-08-24T14:15:22Z",
- "variables": [
- "string"
]
}
Get items
Authorizations:
query Parameters
required | object (Pageable) |
predicate required | object |
target | string Example: target=lastUpdateReason,nextGenerationOf Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
customerId | string Example: customerId=d775dd4f-458e-4493-bfec-fb4a23901580 Filter products by customerId |
lifeTime | string Example: lifeTime=PERMANENT Filter products by subscription lifetime |
subscriptionTemplate | string Example: subscriptionTemplate=NEXWAY_1M Filter products by subscription template |
parentId | string Example: parentId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by parentId |
productFamily | string Example: productFamily=My Product Family Name Filter products by product family |
physical | boolean Example: physical=true Filter physical products |
publisherRefId | string Example: publisherRefId=myPublisherRefId Filter products by publisher reference ID |
salesMode | string Example: salesMode=STANDARD Filter products by sales mode |
fulfillmentTemplate | string Example: fulfillmentTemplate=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by fulfillment template name |
type | string Example: type=SOFTWARE Filter products by product type |
catalogId | string Example: catalogId=af8c3eb5-157f-44db-9492-6b32559d35d0 Filter products by catalog ID |
codeName | string Example: codeName=myCodeName Filter products by code name |
genericName | string Example: genericName=myGenericName Filter products by generic name of the product |
priceFunction | string Example: priceFunction=e3266efa-7cbf-447c-bd53-4a765a0b494e Filter products by price function ID |
sellingStoreS | string Example: sellingStoreS=e3266efa-7cbf-447c-bd53-4a765a0b494e,29c46780-a263-4694-bb9e-286152e688b7 Filter products by availability in stores, may be multiple occurrences of this param |
status | string Example: status=ENABLED Filter products by status (ENABLED/DISABLED) |
blackListedCountries | string Example: blackListedCountries=FR,DE Filter products blacklisted in specific country, may be multiple occurrences of this param |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "items": [
- {
- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "descriptionId": "string",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountsStatus": [
- { }
], - "expirationDate": "2019-08-24T14:15:22Z",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "previousLineItemId": "string",
- "price": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "priceFunctionExecutionErrorMessage": "string",
- "priceFunctionParameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "label": "string",
- "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "signedProduct": "string",
- "storeId": "string",
- "subscriptionTemplate": "string",
- "taxCode": "string",
- "taxExempt": true,
- "trial": true,
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "unitPrice": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "updateDate": "2019-08-24T14:15:22Z",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}
Get the next generation of product according to customerId and publisher ref id
Get the next generation of product according to customerId and publisher ref id
Authorizations:
path Parameters
customerId required | string Example: 17b42c23-1e34-4c8b-bfe4-c06fb64e0b95 Customer id |
publisherRefId required | string Example: 6b49bc08-242b-436d-9f5e-27aef67378dd publisherRef id |
query Parameters
version | integer <int64> Example: version=22 version |
useProductVariationOnly | boolean Example: useProductVariationOnly=true If useProductVariationOnly is true, only search with product who has parent |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "descriptionId": "string",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountsStatus": [
- { }
], - "expirationDate": "2019-08-24T14:15:22Z",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "previousLineItemId": "string",
- "price": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "priceFunctionExecutionErrorMessage": "string",
- "priceFunctionParameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "label": "string",
- "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "signedProduct": "string",
- "storeId": "string",
- "subscriptionTemplate": "string",
- "taxCode": "string",
- "taxExempt": true,
- "trial": true,
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "unitPrice": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "updateDate": "2019-08-24T14:15:22Z",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Response samples
- 200
- 401
- 403
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "descriptionId": "string",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountsStatus": [
- { }
], - "expirationDate": "2019-08-24T14:15:22Z",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "previousLineItemId": "string",
- "price": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "priceFunctionExecutionErrorMessage": "string",
- "priceFunctionParameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "label": "string",
- "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "signedProduct": "string",
- "storeId": "string",
- "subscriptionTemplate": "string",
- "taxCode": "string",
- "taxExempt": true,
- "trial": true,
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "unitPrice": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "updateDate": "2019-08-24T14:15:22Z",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get public description of product
Get public description for the given product id
Authorizations:
query Parameters
id required | string Example: id=33447220-3716-4ce8-9694-1124b0f1a458 Product id |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "description": "string",
- "fallbackLocale": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "localizedLongDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedManualRenewalEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedMarketingName": {
- "property1": "string",
- "property2": "string"
}, - "localizedPurchaseEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedShortDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedSubscriptionEmailDesc": {
- "property1": "string",
- "property2": "string"
}, - "localizedThankYouDesc": {
- "property1": "string",
- "property2": "string"
}, - "longDesc": "string",
- "manualRenewalEmailDesc": "string",
- "marketingName": "string",
- "modelVersion": "string",
- "purchaseEmailDesc": "string",
- "shortDesc": "string",
- "subscriptionEmailDesc": "string",
- "thankYouDesc": "string",
- "updateDate": "2019-08-24T14:15:22Z",
- "variableDescriptions": [
- {
- "description": "string",
- "label": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "variableValueDescriptions": [
- {
- "descValue": "string",
- "description": "string",
- "localizedValue": {
- "property1": "string",
- "property2": "string"
}
}
]
}
]
}
Get the next generation of product
Get the next generation of product for the given product id
Authorizations:
path Parameters
id required | string Example: 9bc202c5-6b54-4ae9-8df9-6edb82759ed6 Product id |
query Parameters
version | integer <int64> Example: version=22 Version |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "activationLink": {
- "enabled": true,
- "providerId": "string"
}, - "blackListedCountries": [
- "string"
], - "businessSegment": "B2C",
- "catalogId": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "customFields": {
- "property1": { },
- "property2": { }
}, - "customFieldsId": "string",
- "customerId": "string",
- "dbVersion": 0,
- "defaultCurrency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "descriptionId": "string",
- "discountPlan": {
- "discountStep": 0,
- "ignorePurchaseDiscount": true,
- "tag": "string"
}, - "discountsStatus": [
- { }
], - "expirationDate": "2019-08-24T14:15:22Z",
- "externalContext": "string",
- "forcedCrossSaleProductIds": [
- "string"
], - "fulfillmentTemplate": "string",
- "fulfillmentTemplateName": "string",
- "id": "string",
- "lastUpdateReason": "string",
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "lifeTime": "1YEAR",
- "modelVersion": "string",
- "nextGenerationOf": [
- "string"
], - "paidTrial": true,
- "parentId": "string",
- "physical": true,
- "previousLineItemId": "string",
- "price": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "priceFunctionExecutionErrorMessage": "string",
- "priceFunctionParameters": [
- {
- "defaultValue": "string",
- "field": "string",
- "internalDesc": "string",
- "label": "string",
- "max": 0,
- "min": 0,
- "pattern": "string",
- "type": "INTEGER"
}
], - "priceFunctionParametersValues": {
- "property1": "string",
- "property2": "string"
}, - "productFamily": "string",
- "publisherProductId": "string",
- "publisherRefId": "string",
- "relatedContents": [
- {
- "file": "string",
- "label": "string"
}
], - "releaseDate": "2019-08-24T14:15:22Z",
- "resources": [
- {
- "url": "string"
}
], - "salesMode": "BILLING_PLAN",
- "signedProduct": "string",
- "storeId": "string",
- "subscriptionTemplate": "string",
- "taxCode": "string",
- "taxExempt": true,
- "trial": true,
- "trialAllowed": true,
- "trialDuration": 0,
- "type": "SOFTWARE",
- "unifiedRegisterSoftware": true,
- "unitPrice": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "updateDate": "2019-08-24T14:15:22Z",
- "variableValues": {
- "property1": { },
- "property2": { }
}, - "variables": [
- {
- "defaultValue": { },
- "field": "string",
- "internalDesc": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "localizedValue": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "type": "LIST",
- "value": { }
}
], - "variantOf": "string",
- "visualTags": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Get the next generations information for a product
Authorizations:
path Parameters
productId required | string |
query Parameters
required | object (NextGenerationsQueryParameters) |
Responses
Response samples
- 200
- 400
- 404
- 500
[- {
- "finalPrice": 0.1,
- "price": {
- "crossSell": 0.1,
- "currency": {
- "currencyCode": "string",
- "defaultFractionDigits": 0,
- "displayName": "string",
- "numericCode": 0,
- "numericCodeAsString": "string",
- "symbol": "string"
}, - "discountedPrice": {
- "discountedGrossPrice": 0.1
}, - "grossMsrp": 0.1,
- "grossPrice": 0.1,
- "initialGrossPrice": 0.1,
- "initialNetPrice": 0.1,
- "initialValue": 0.1,
- "initialVatAmount": 0.1,
- "mandateValue": 0.1,
- "marketingCampaignId": "string",
- "msrp": 0.1,
- "netMsrp": 0.1,
- "netPrice": 0.1,
- "productRecoType": "string",
- "remotePrice": {
- "licenseNextExpirationDate": "2019-08-24T14:15:22Z",
- "response": "string",
- "url": "string"
}, - "source": "INTERNAL",
- "upSell": 0.1,
- "value": 0.1,
- "vatAmount": 0.1,
- "vatAmountMsrp": 0.1,
- "vatIncluded": true,
- "vatRate": 0.1
}, - "productId": "string",
- "subscriptionGeneration": 0
}
]