Product resource

Methods

  • post - Create a product
  • get - Get the next generation of product
  • get - Get a product by id
  • put - put
  • patch - Update a product

Resource

{
    "availableVariables": [
        {
            "defaultValue": {},
            "field": "string",
            "internalDesc": "string",
            "labels": {
                "<key>": "string"
            },
            "localizedValue": {
                "<key>": {
                    "<key>": "string"
                }
            },
            "type": "string",
            "value": {}
        }
    ],
    "codeName": "string",
    "createDate": "date-time",
    "customerId": "string",
    "dbVersion": "int64",
    "defaultLocale": "string",
    "externalContext": "string",
    "fulfillmentTemplate": "string",
    "genericName": "string",
    "id": "string",
    "lifeTime": "string",
    "localizedLongDesc": {
        "<key>": "string"
    },
    "localizedShortDesc": {
        "<key>": "string"
    },
    "marketingName": {
        "<key>": "string"
    },
    "modelVersion": "string",
    "nextGenerationOf": [
        "string"
    ],
    "parentId": "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",
    "status": "string",
    "subProducts": [
        "string"
    ],
    "subscriptionTemplate": "string",
    "type": "string",
    "updateDate": "date-time",
    "visualTags": {
        "<key>": [
            "string"
        ]
    }
}

Properties

Name Type Description Additional
availableVariables[] array

Available variables of the product

Optional
availableVariables[].defaultValue object

Name of the variable

availableVariables[].field string

Name of the variable

availableVariables[].internalDesc string

Internal description of the variable

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

The type of the variable

Possible values are:

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

Possible values of the variable

Optional
codeName string

Code name of product

Optional
createDate date-time Optional
customerId string

Customer id of the product

Read only.
dbVersion int64 Optional
defaultLocale string

Default locale of the product

externalContext string

External context

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 names

marketingName.<key> map of string Optional
modelVersion string Optional
nextGenerationOf[] array of string

List of old generation IDs

Optional
parentId string

Parent id of the product

Optional, read only.
priceFunction string

Price function ID

Optional
prices object Prices
prices.defaultCurrency string

Default currency (ISO-4217) of the product

prices.priceByCountryByCurrency object

Detail the price of product by currency (ISO-4217) and country (ISO-3166-1 alpha-2), each currency needed 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 price of product, use -1 to specify to use the currency price for this country

prices.priceByCountryByCurrency.<key>.<key>.vatIncluded boolean

Indicated if the price include the VAT

Optional
pricesByStores object

Override the product price for a specific store

pricesByStores.<key> map of object Prices Optional
pricesByStores.<key>.defaultCurrency string

Default currency (ISO-4217) of the product

pricesByStores.<key>.priceByCountryByCurrency object

Detail the price of product by currency (ISO-4217) and country (ISO-3166-1 alpha-2), each currency needed 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 price of product, use -1 to specify to use the currency price for this country

pricesByStores.<key>.priceByCountryByCurrency.<key>.<key>.vatIncluded boolean

Indicated if the price include the VAT

Optional
productFamily string

Family of product

Optional
publisherRefId string

Publisher reference of the product

relatedContents[] array

Links for download the related contents file of product

Optional
relatedContents[].file string

Download link or filename with extension

relatedContents[].label string

Text for explain what is this file

resources[] array

Resources of the product

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:

  • ENABLED
  • DISABLED
Optional, read only.
subProducts[] array of string

List of subproduct IDs

Optional
subscriptionTemplate string

Subscription template name

Optional
type string

Type of product

Possible values are:

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

Visual tags linked to the product

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

Example

{
    "prices": {}
}