LicenseRequest resource

Methods

  • post - Send a cancel request to the partner
  • post - Send a new request to the partner
  • post - Send a pause request to the partner
  • post - Send a reactivate request to the partner
  • post - Send a renew request to the partner
  • post - Send a suspend request to the partner

Resource

{
    "metadata": {
        "externalContext": "string",
        "order": "string"
    },
    "product": {
        "endDate": "string",
        "initialNexwayFulfillmentId": "string",
        "licenses": [
            {
                "activationCode": "string"
            }
        ],
        "nexwayFulfillmentId": "string",
        "nexwayProductId": "string",
        "publisherFulfillmentId": "string",
        "publisherProductId": "string",
        "quantity": "int32",
        "startDate": "string"
    },
    "user": {
        "companyName": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
    }
}

Properties

Name Type Description Additional
metadata object

This is the metadata / context the action.

Optional
metadata.externalContext string

This external context will be the one provided in the cart url.

Optional
metadata.order string

This is the order number/id.

Optional
product object

Product details to request a license.

Optional
product.endDate string

date in https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates

Optional
product.initialNexwayFulfillmentId string

A unique identifier for the fulfillment. This id is the one that identify the initial fulfillment in the Nexway information system.

Optional
product.licenses[] array Optional
product.licenses[].activationCode string

Depending on the action and the goal, this means activation to activate/To cancel or to get.

Optional
product.nexwayFulfillmentId string

A unique identifier for the fulfillment. This id is the one that identify this fulfillment in the Nexway information system.

product.nexwayProductId string

A unique identifier for the product. This id is the one that identify the product in the nexway information system.

product.publisherFulfillmentId string

A unique identifier for the fulfillment. This id is the one that identify the initial fulfillment in your information system.

Optional
product.publisherProductId string

A unique identifier for the product. This id is the one that identify your product in your information system.

product.quantity int32

number of products for which a license is required.

Optional
product.startDate string

date in https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates

Optional
user object

This is the end user buying the product and needing the license.

Optional
user.companyName string Optional
user.email string
user.firstName string Optional
user.lastName string Optional

Example

{
    "metadata": {},
    "product": {
        "initialNexwayFulfillmentId": "dc5fdcc2-3ee3-11e7-a919-92ebcb67fe33",
        "nexwayFulfillmentId": "f84f08c2-3ee3-11e7-a919-92ebcb67fe33",
        "nexwayProductId": "XASTF12512",
        "publisherFulfillmentId": "d29a1432-3ee3-11e7-a919-92ebcb67fe33",
        "publisherProductId": "MS56493XT",
        "quantity": 1
    },
    "user": {}
}