Product resource

Methods

  • post - Create a product
  • get - Get a product by id
  • get - Get a product by id via public context
  • put - Update a product

Resource

{
    "assets": [
        {
            "id": "string",
            "type": "string",
            "url": "string"
        }
    ],
    "createDate": "int64",
    "currencyValue": {
        "<key>": "number"
    },
    "customerId": "string",
    "defaultCurrency": "string",
    "defaultLocale": "string",
    "defaultPrices": {
        "<key>": {
            "currency": "string",
            "overridden": "boolean",
            "price": "number"
        }
    },
    "fulfillmentTemplate": "string",
    "id": "string",
    "lifeTime": {
        "duration": "int64",
        "period": "string"
    },
    "longDescData": {
        "<key>": "string"
    },
    "nameData": {
        "<key>": "string"
    },
    "publisherProductId": "string",
    "seats": "int32",
    "shortDescData": {
        "<key>": "string"
    },
    "sku": "string",
    "status": "string",
    "stock": "int64",
    "storePrices": {
        "<key>": {
            "<key>": {
                "currency": "string",
                "overridden": "boolean",
                "price": "number"
            }
        }
    },
    "subscriptionModelId": "string",
    "updateDate": "int64"
}

Properties

Name Type Description Additional
assets[] array

Assets of the product

Optional
assets[].id string

Asset id

Optional, read only.
assets[].type string

Type of asset

assets[].url string

URL of the asset

createDate int64 Optional, read only.
currencyValue object

Price by currency (ISO-4217) of the product

currencyValue.<key> map of number Optional
customerId string

Customer id of the product

Read only.
defaultCurrency string

Default currency (ISO-4217) of the product

Optional
defaultLocale string

Default locale of the product

defaultPrices object

Price by country of the product

defaultPrices.<key> map of object Price Optional
defaultPrices.<key>.currency string

Currency type

defaultPrices.<key>.overridden boolean

Price overridden or not compared to default prices

Optional
defaultPrices.<key>.price number

Price of the product

fulfillmentTemplate string

Fulfillment template name

Optional
id string Optional, read only.
lifeTime object LifeTime
lifeTime.duration int64

Duration of the life time of product

Optional
lifeTime.period string

The period of the life time

Possible values are:

  • MONTH
  • YEAR
  • PERMANENT
longDescData object

Product long description

longDescData.<key> map of string Optional
nameData object

Product name

nameData.<key> map of string Optional
publisherProductId string

Publisher Product Id

Optional
seats int32

number of seats

Optional
shortDescData object

Product short description

shortDescData.<key> map of string Optional
sku string

SKU of the product

status string

Product status

Possible values are:

  • ENABLED
  • DISABLED
  • DELETED
Optional, read only.
stock int64

Stock of the product

Optional
storePrices object

Price by country and by store of the product

storePrices.<key> map of object Optional
storePrices.<key>.<key> map of object Price Optional
storePrices.<key>.<key>.currency string

Currency type

storePrices.<key>.<key>.overridden boolean

Price overridden or not compared to default prices

Optional
storePrices.<key>.<key>.price number

Price of the product

subscriptionModelId string

Subscription model id

Optional
updateDate int64 Optional, read only.

Example

{
    "createDate": 1.479225750482e+12,
    "customerId": "a0253398-b0c5-4c2d-a15f-bd97ea4be60",
    "defaultCurrency": "EUR",
    "defaultLocale": "en-US",
    "fulfillmentTemplate": "avast",
    "lifeTime": {
        "duration": 2,
        "period": "YEAR"
    },
    "longDescData": "{\"en-GB\":\"Long description\" }",
    "nameData": "{\"en-GB\":\"Name\" }",
    "publisherProductId": "a0253398-b0c5-4c2d-a15f-bd97ea4be60",
    "seats": 15,
    "shortDescData": "{\"en-GB\":\"Short description\" }",
    "sku": "SKU",
    "status": "ENABLED",
    "stock": 1,
    "subscriptionModelId": "CUSTOMER_ABO_1Y",
    "updateDate": 1.479225750482e+12
}