You need to have a valid JWT to access this API. Please read JWT Authentication.
POST https://api.nexway.store/products
Parameter name | Value | Description | Additional |
---|---|---|---|
autoDetectOverriding | boolean | ||
autoBreakExistingNextGenerationReference | boolean | ||
force | boolean | ||
dryRun | boolean |
The request body takes a complete Product resource, containing the following writable properties:
{
"availableVariables": [
{
"defaultValue": {},
"field": "string",
"internalDesc": "string",
"labels": {
"<key>": "string"
},
"localizedValue": {
"<key>": {
"<key>": "string"
}
},
"type": "string",
"value": {}
}
],
"blackListedCountries": [
"string"
],
"catalogId": "string",
"codeName": "string",
"createDate": "date-time",
"dbVersion": "int64",
"defaultLocale": "string",
"externalContext": "string",
"forcedCrossSaleProductIds": [
"string"
],
"fulfillmentTemplate": "string",
"genericName": "string",
"id": "string",
"lifeTime": "string",
"localizedLongDesc": {
"<key>": "string"
},
"localizedShortDesc": {
"<key>": "string"
},
"marketingName": {
"<key>": "string"
},
"nextGenerationOf": [
"string"
],
"physical": "boolean",
"priceFunction": "string",
"prices": {
"defaultCurrency": "string",
"priceByCountryByCurrency": {
"<key>": {
"<key>": {
"value": "double",
"vatIncluded": "boolean"
}
}
}
},
"pricesByStores": {
"<key>": {
"defaultCurrency": "string",
"priceByCountryByCurrency": {
"<key>": {
"<key>": {
"value": "double",
"vatIncluded": "boolean"
}
}
}
}
},
"productFamily": "string",
"publisherRefId": "string",
"relatedContents": [
{
"file": "string",
"label": "string"
}
],
"resources": [
{
"url": "string"
}
],
"sellingStores": [
"string"
],
"signedProduct": "string",
"status": "string",
"subProducts": [
"string"
],
"subscriptionTemplate": "string",
"thankYouDesc": {
"<key>": "string"
},
"type": "string",
"updateDate": "date-time",
"visualTags": {
"<key>": [
"string"
]
}
}
Name | Type | Description | Additional |
---|---|---|---|
availableVariables[] | array |
Available product variables |
Optional |
availableVariables[].defaultValue | object |
Name of variable |
|
availableVariables[].field | string |
Variable name |
|
availableVariables[].internalDesc | string |
Variable internal description |
Optional |
availableVariables[].labels | object | Optional | |
availableVariables[].labels.<key> | map of string | Optional | |
availableVariables[].localizedValue | object |
Localized values of the variable |
Optional |
availableVariables[].localizedValue.<key> | map of object | Optional | |
availableVariables[].localizedValue.<key>.<key> | map of string | Optional | |
availableVariables[].type | string |
Variable type Possible values are:
|
|
availableVariables[].value | object |
Possible values of variable |
Optional |
blackListedCountries[] | array of string |
List of countries not authorized for this product |
Optional |
catalogId | string |
Catalog ID |
Optional |
codeName | string |
Code name of product |
Optional |
createDate | date-time | Optional | |
dbVersion | int64 | Optional | |
defaultLocale | string |
Default locale of product |
|
externalContext | string |
External context |
Optional |
forcedCrossSaleProductIds[] | array of string |
List of forced cross-sales product IDs |
Optional |
fulfillmentTemplate | string |
Fulfillment template name |
Optional |
genericName | string |
Name of product |
Optional |
id | string | Optional | |
lifeTime | string |
lifeTime |
|
localizedLongDesc | object |
Product long description |
Optional |
localizedLongDesc.<key> | map of string | Optional | |
localizedShortDesc | object |
Product short descriptions |
Optional |
localizedShortDesc.<key> | map of string | Optional | |
marketingName | object |
Product name |
|
marketingName.<key> | map of string | Optional | |
nextGenerationOf[] | array of string |
List of old generation IDs |
Optional |
physical | boolean |
Indicates if the product is physical/digital |
Optional |
priceFunction | string |
Price function ID |
Optional |
prices | object | Prices | |
prices.defaultCurrency | string |
Product default currency (ISO-4217 format) |
|
prices.priceByCountryByCurrency | object |
Product price by currency (ISO-4217) and country (ISO-3166-1 alpha-2); each currency requires a default price |
|
prices.priceByCountryByCurrency.<key> | map of object | Optional | |
prices.priceByCountryByCurrency.<key>.<key> | map of object | PriceInformation | Optional |
prices.priceByCountryByCurrency.<key>.<key>.value | double |
The product price; enter -1 to use the currency price for this country |
|
prices.priceByCountryByCurrency.<key>.<key>.vatIncluded | boolean |
Indicates if the price includes VAT |
Optional |
pricesByStores | object |
Override the product price for a specific store |
|
pricesByStores.<key> | map of object | Prices | Optional |
pricesByStores.<key>.defaultCurrency | string |
Product default currency (ISO-4217 format) |
|
pricesByStores.<key>.priceByCountryByCurrency | object |
Product price by currency (ISO-4217) and country (ISO-3166-1 alpha-2); each currency requires a default price |
|
pricesByStores.<key>.priceByCountryByCurrency.<key> | map of object | Optional | |
pricesByStores.<key>.priceByCountryByCurrency.<key>.<key> | map of object | PriceInformation | Optional |
pricesByStores.<key>.priceByCountryByCurrency.<key>.<key>.value | double |
The product price; enter -1 to use the currency price for this country |
|
pricesByStores.<key>.priceByCountryByCurrency.<key>.<key>.vatIncluded | boolean |
Indicates if the price includes VAT |
Optional |
productFamily | string |
Product family |
Optional |
publisherRefId | string |
Product publisher reference |
|
relatedContents[] | array |
Links for downloading product-related content file |
Optional |
relatedContents[].file | string |
Download link or filename with extension |
|
relatedContents[].label | string |
Explanation of what this file is |
|
resources[] | array |
Product resources |
Optional |
resources[].url | string |
URL of the asset |
|
sellingStores[] | array of string |
List of stores selling this product |
|
signedProduct | string | Optional | |
status | string |
Product status Possible values are:
|
Optional |
subProducts[] | array of string |
List of sub-product IDs |
Optional |
subscriptionTemplate | string |
Subscription template name |
Optional |
thankYouDesc | object |
Thank-you page description |
Optional |
thankYouDesc.<key> | map of string | Optional | |
type | string |
Product type Possible values are:
|
Optional |
updateDate | date-time | Optional | |
visualTags | object |
Visual tags linked to product |
Optional |
visualTags.<key>[] | array of string | Optional |
You need to have a valid JWT to access this API. Please read JWT Authentication.
This request requires the use of one of following authorisation methods:
OAuth2
.
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK Success |
Product |
201 | Created Created |
Created |
401 | Unauthorized Unauthorized |
|
403 | Forbidden Forbidden |
|
404 | Not Found Not Found |
|
500 | Internal Server Error Failure |
{
"prices": {}
}
This software product will have the following features:
Requires an activation key which can be provided via a fulfillment template resource
{
"customerId": "a64581ab-a6ef-4ad8-b84c-75f0168413dc",
"genericName": "My software",
"marketingName": {
"de-DE": "Meine erstaunliche software",
"fr-FR": "Mon logiciel incroyable",
"en-US": "My incredible software"
},
"localizedShortDesc": {
"de-DE": "<p>short DE</p>",
"fr-FR": "<p>short FR</p>",
"en-US": "<p>Short US</p>"
},
"localizedLongDesc": {
"de-DE": "<p>long</p>",
"fr-FR": "<p>long FR</p>",
"en-US": "<p>long</p>"
},
"defaultLocale": "en-US",
"publisherRefId": "SKU001",
"type": "SOFTWARE",
"lifeTime": "1YEAR",
"externalContext": "whatever-you-want",
"fulfillmentTemplate": "Com2UsKeyActivator",
"sellingStores": [
"454ad648-7540-9544-95ad-7415744f6ad7"
],
"prices": {
"defaultCurrency": "USD",
"priceByCountryByCurrency": {
"EUR": {
"default": {
"value": 10.99,
"vatIncluded": true
}
},
"GBP": {
"default": {
"value": 20,
"vatIncluded": true
}
},
"USD": {
"default": {
"value": 15,
"vatIncluded": true
}
}
}
}
}
Same features as the parent product except for the lifetime and price list.
parentId
refers to the core product previously created.
{
"parentId": "<Core product Id>",
"lifeTime": "2YEAR",
"prices": {
"defaultCurrency": "USD",
"priceByCountryByCurrency": {
"EUR": {
"default": {
"value": 7.69,
"vatIncluded": true
}
},
"GBP": {
"default": {
"value": 15,
"vatIncluded": true
}
},
"USD": {
"default": {
"value": 12.34,
"vatIncluded": true
}
}
}
}
}