Nexway Connect (1.0)
Download OpenAPI specification:Download
License: Nexway License Version 1.0
Nexway Connect API
Get all categories and subcategories of Nexway products
Get all categories and subcategories of Nexway products
Authorizations:
Bearer
path Parameters
| language required | string Categories description language |
header Parameters
| secret required | string Access secret |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "responseCode": 0,
- "responseMessage": "OK",
- "categoryList": [
- {
- "id": 7466,
- "label": "Anti-Virus & Security",
- "Subcategory list": [
- {
- "id": 7467,
- "label": "Antivirus"
}
]
}
]
}Get all operating systems of Nexway products
Get all operating systems of Nexway products
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "responseCode": 0,
- "responseMessage": "OK",
- "osList": [
- {
- "id": 63,
- "label": "Win 10 32/64 bits"
}
]
}Create a new order
Create a new order entry
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
CreateOrderRequest
| partnerOrderNumber required | string Your unique order number |
| orderDate required | string The date of the order, must respect the ISO 8601 format. Example: 2004-02-12T15:19:21+00:00 |
| marketingProgramId | string Allows the marketing department to find the order |
| currency required | string The currency used for the transaction, must respect the ISO 4217 format. Example: EUR |
required | Array of objects (OrderLines) The details of products in the order |
required | object (Customer) Contains information about the customer |
object (Payment) Contains payment information. | |
Array of objects (Discount) Allows to set one or many discounts | |
Array of objects (OrderMetadata) Allows to set various type of data |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXXXXX",
- "orderDate": "2004-02-12T15:19:21+00:00",
- "marketingProgramId": "XXXXXXXXXXXXX",
- "currency": "EUR",
- "orderLines": [
- {
- "productRef": "XXXXX",
- "quantity": 0,
- "vatRate": 0,
- "amountDutyFree": 0,
- "amountTotal": 0,
- "endUserEmail": "XXXXXX",
- "discounts": [
- {
- "foreignRef": "XXXXXXX",
- "label": "XXXXXXX",
- "priceDelta": 0,
- "operation": "Percents",
- "operationValue": 0
}
]
}
], - "customer": {
- "partnerId": "XXXXXXX",
- "email": "XXXXX@XX",
- "language": "fr_FR",
- "locationDelivery": {
- "companyName": "XXXXXXXXXX",
- "title": 0,
- "lastName": "XXXXXXXXXX",
- "firstName": "XXXXXXXXXX",
- "address1": "XXXXXXXXXX",
- "address2": "XXXXXXXXXX",
- "zipCode": "XXXXXXXXXX",
- "city": "XXXXXXXXXX",
- "province": "XXXXXXXXXX",
- "country": "FR",
- "phone": "XXXXXXXXXX",
- "fax": "XXXXXXXXXX"
}, - "locationInvoice": {
- "companyName": "XXXXXXXXXX",
- "title": 0,
- "lastName": "XXXXXXXXXX",
- "firstName": "XXXXXXXXXX",
- "address1": "XXXXXXXXXX",
- "address2": "XXXXXXXXXX",
- "zipCode": "XXXXXXXXXX",
- "city": "XXXXXXXXXX",
- "province": "XXXXXXXXXX",
- "country": "FR",
- "phone": "XXXXXXXXXX",
- "fax": "XXXXXXXXXX"
}, - "ipV4": "127.0.0.1",
- "ipV6": "2001:0db8:0000:85a3:0000:0000:ac1f:8001"
}, - "payment": {
- "paymentMethod": "External Payment"
}, - "discounts": [
- {
- "foreignRef": "XXXXXXX",
- "label": "XXXXXXX",
- "priceDelta": 0,
- "operation": "Percents",
- "operationValue": 0
}
], - "metadata": [
- {
- "key": "XXXX",
- "value": "XXXX"
}
]
}Response samples
- 201
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXX",
- "orderNumber": 12345678,
- "orderLines": [
- {
- "productRef": 12345,
- "lineItems": [
- {
- "serials": [
- {
- "data": "XXX-XXXX-XXXX-XXXX-XXXX",
- "encoding": "base64|text",
- "charset": "utf-8",
- "fileName": "Serial.DAT"
}
], - "subscriptionId": 0,
- "responseCode": 0,
- "responseMessage": "OK"
}
], - "files": [
- {
- "label": "Game label",
- "type": "patch|doc|install|...",
- "size": 654,
- "group": "XXX"
}
], - "dateEndDownload": "2017-04-12",
- "remark": "string",
- "digitalLockerLink": "www.example.com/?token=XXXX",
- "responseCode": 0,
- "responseMessage": "OK"
}
], - "downloadManager": {
}, - "responseCode": 0,
- "responseMessage": "OK"
}Cancel an order
Cancel an order by updating it
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
CancelOrderRequest
| partnerOrderNumber required | string Your unique order number as string |
| reasonCode required | integer <int32> The reason of cancellation. Possible values - 2: Order Cancelled, 3: Unsatisfied customer, 4: Double Order, 5: Product Error, 6: Incompatible product, 16: Fraud/Charge back |
| comment | string A text in complement of the reason |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXX",
- "reasonCode": 2,
- "comment": "XXXXXX"
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXX",
- "orderNumber": "54654",
- "responseCode": 0,
- "responseMessage": "OK",
- "subscriptionStatusCode": 200,
- "subscriptionStatus": "Subscription cancelled"
}Update download time of an order
Update download time of an order
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
UpdateDownloadTimeRequest
| partnerOrderNumber required | string Your unique order number |
| value required | string The date value for new download expiry date. Example: P1Y4M3D |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXXXX",
- "value": "P1Y4M3D"
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "GMFSERZ30071981",
- "newDownloadEndDate": "2011-05-27",
- "responseCode": 0,
- "responseMessage": "OK"
}Get an order data
Get an order information
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXX",
- "orderNumber": 65464,
- "orderLines": [
- {
- "productRef": 12345,
- "lineItems": [
- {
- "serials": [
- {
- "data": "XXX-XXXX-XXXX-XXXX-XXXX",
- "encoding": "base64|text",
- "charset": "utf-8",
- "fileName": "Serial.DAT"
}
], - "subscriptionId": 0,
- "responseCode": 0,
- "responseMessage": "OK"
}
], - "files": [
- {
- "label": "Game label",
- "type": "patch|doc|install|...",
- "size": 654,
- "group": "XXX"
}
], - "dateEndDownload": "2017-04-12",
- "remark": "string",
- "digitalLockerLink": "www.example.com/?token=XXXX",
- "responseCode": 0,
- "responseMessage": "OK"
}
], - "downloadManager": {
}, - "responseCode": 0,
- "responseMessage": "OK"
}Get download information of an order
Get download information related to an order
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXXX",
- "downloadEndDate": "2011-04-20",
- "orderLines": [
- {
- "productRef": 12345678,
- "files": [
- {
- "label": "File1 label",
- "type": "install",
- "size": 2023751,
- "group": "xxxxxxxxx",
- "dateFirstDownload": "xxxx-xx-xx",
- "dateLastDownload": "xxxx-xx-xx",
- "countStartDownload": 1,
- "countCompleteDownload": 0
}
]
}
], - "responseCode": 0,
- "responseMessage": "OK"
}Get stock info for products
Get stock info for products
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
GetStockStatusRequest
| productRefs required | Array of integers <int32> [ items <int32 > ] List of productRef numbers |
Responses
Request samples
- Payload
Content type
application/json
{- "productRefs": [
- 0
]
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "stockStatusList": [
- {
- "productRef": 12345678,
- "status": 100,
- "responseCode": 0,
- "responseMessage": "productRef not found"
}
]
}Get cross-/up-sell products for order
Get cross-/up-sell products for order
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
GetCrossUpSellRequest
| language required | string Languages list (use ISO 3166-1-alpha-2 format). This method accepts one language or list of languages separated with a comma. Example: EN,FR,PT |
required | Array of objects (Product) List of products with product refs and quantities |
Responses
Request samples
- Payload
Content type
application/json
{- "language": "EN,FR,PT",
- "products": [
- {
- "productRef": 654917,
- "quantity": 1
}
]
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "productsReturn": [
- {
- "ref": 654917,
- "type": "up",
- "name": "101 Airborne",
- "amountDutyFree": 6.6806,
- "currency": "GBP",
- "shortDescription": "Lead a squad of 18 paratroopers behind enemy lines in this strategy-based simulation of squad level combat based on the D-Day landings in Normandy.",
- "language": "EN",
- "imageSmall": "empire/airborne19.gif"
}
], - "responseCode": 0,
- "responseMessage": "OK"
}Cancel Subscription
Cancel Subscription
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
SubscriptionRequest
| partnerOrderNumber required | string Your unique order number |
| subscriptionId required | integer <int32> An ID corresponding to subscription in given order |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXX",
- "subscriptionId": 0
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXX",
- "orderNumber": "54654",
- "subscriptionId": 54654,
- "responseCode": 0,
- "responseMessage": "OK"
}Get subscription status
Get subscription status
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
SubscriptionRequest
| partnerOrderNumber required | string Your unique order number |
| subscriptionId required | integer <int32> An ID corresponding to subscription in given order |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXX",
- "subscriptionId": 0
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "subscriptionId": 0,
- "productRef": 0,
- "period": "XXXXXXXX",
- "generation": 0,
- "technicalStatus": "XXXXXXXX",
- "currency": "EUR",
- "amount": 0,
- "code": 200,
- "message": "Success",
- "creationDatetime": "string",
- "updateDatetime": "string",
- "update_datetime": "string",
- "expirationDatetime": "string",
- "nextStatusChangeDatetime": "string"
}Renew subscription
Renew subscription of an order
Authorizations:
Bearer
header Parameters
| secret required | string Access secret |
Request Body schema: application/jsonrequired
SubscriptionRequest
| partnerOrderNumber required | string Your unique order number |
| subscriptionId required | integer <int32> An ID corresponding to subscription in given order |
Responses
Request samples
- Payload
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXXXX",
- "subscriptionId": 0
}Response samples
- 200
- 401
- 403
- 404
- 500
Content type
application/json
{- "partnerOrderNumber": "XXXXXXXX",
- "subscriptionId": 0,
- "period": "XXXXXXXX",
- "code": 0,
- "message": "Subscription renewed"
}