Update a product

You need to have a valid JWT to access this API. Please read JWT Authentication.

Request

PUT https://api.nexway.store/products/{id}

Path parameters

Parameter name Value Description Additional
id string

product ID

Required

Query parameters

Parameter name Value Description Additional
autoDetectOverriding boolean
autoBreakExistingNextGenerationReference boolean
force boolean
dryRun boolean

Request body

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": {}
        }
    ],
    "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"
    ],
    "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",
    "subProducts": [
        "string"
    ],
    "subscriptionTemplate": "string",
    "thankYouDesc": {
        "<key>": "string"
    },
    "type": "string",
    "updateDate": "date-time",
    "visualTags": {
        "<key>": [
            "string"
        ]
    }
}

Properties

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:

  • LIST
  • RANGE
  • BOOL
availableVariables[].value object

Possible values of variable

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
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
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:

  • SOFTWARE
  • GAMES
  • CASUAL
  • SERVICE
Optional
updateDate date-time Optional
visualTags object

Visual tags linked to product

Optional
visualTags.<key>[] array of string Optional

Authorisation

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.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

Product
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "prices": {}
}

Explore this API

id

product ID

autoDetectOverriding
autoBreakExistingNextGenerationReference
force
dryRun
product

product

Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!