Create a product

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

Request

POST https://api.nexway.store/products

Query parameters

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

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.

Example

{
    "prices": {}
}

Sample of core product with a 1-year subscription

This software product will have the following features:

• Available in 1 store
• 3 different currencies (default USD)
• Localized for 3 places (default en-US)

• 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
              }
          }
      }
  }
  }
  

Sample of a variant of the above product, this time with a 2-year subscription

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

---

Explore this API

autoDetectOverriding	true false
autoBreakExistingNextGenerationReference	true false
force	true false
dryRun	true false
product		product
Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token

Access token to be used for request

Try it out!

Request

Response status

Response body

Response headers