Send a renew request to the partner

Providing to the Nexway partner all information about the purchase to renew a license.

Request

POST https://api.staging.nexway.build/sample-fulfillment-provider/licenses/renew

Request body

The request body takes a complete LicenseRequest resource, containing the following writable properties:

{
    "metadata": {
        "externalContext": "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
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 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

Authorisation

This request requires the use of one of following authorisation methods: API key .

Response

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

Status code Description Resource
200 OK

request correctly processed. License generated/suspended/renewed..., find it in the response body.

InlineResponse200
400 Bad Request

The provided data do not meet requirements

401 Unauthorized

Please authenticate

409 Conflict

The body of request body has already been processed before

500 Internal Server Error

Internal error

503 Service Unavailable

Service is unavailable, please retry later

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": {}
}

Explore this API

licenseRequest

this structure convey informations about a purchase (the product and license)

Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Try it out!