Skip to main content
API docs by Redocly

Order (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage monetize orders

Order

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string
endUser.email
any

Filter orders by endUser email

endUser.country
any

Filter orders by endUser country

endUser.accountCreated
any

Filter orders by endUser accountCreated

customer.id
any

Filter orders by customer id

lineItem.id
any

Filter orders by lineItem id

lineItem.previousLineItemId
any

Filter orders by lineItem previousLineItemId

lineItem.subscriptionTemplate
any

Filter orders by lineItem subscriptionTemplate

lineItem.subscriptionId
any

Filter orders by lineItem subscriptionId

lineItem.publisherRefId
any

Filter orders by lineItem publisherRefId

lineItem.nexwayFulfillmentId
any

Filter orders by lineItem nexwayFulfillmentId

lineItem.publisherFulfillmentId
any

Filter orders by lineItem publisherFulfillmentId

lineItem.fulfillmentTemplate
any

Filter orders by lineItem fulfillmentTemplate

lineItem.activationCode
any

Filter orders by lineItem activationCode

email.emailId
any

Filter orders by emailId

invoice.id
any

Filter orders by invoice id

creditNote.id
any

Filter orders by creditNote id

creditNote.cancellationReason
any

Filter orders creditNote cancellationReason

creditNote.date
any

Filter orders creditNote date

currency
any

Filter orders by currency

cartId
any

Filter orders by cartId

subscriptionId
any

Filter orders by subscriptionId

generationId
any

Filter orders by generationId

status
any

Filter orders by status (CANCELED_WITH_ERROR/CANCEL_PENDING/CANCELED/PARTIAL_CANCELED/PARTIAL_COMPLETED/COMPLETED/ABORTED/PENDING_WITH_ERROR/PENDING/FRAUD_PENDING/PAYMENT_PENDING/PAYMENT_REFUSED/CREATED/FORCE_COMPLETED/FORCE_CANCELED)

source
any

Filter orders by source (PURCHASE/SUBSCRIPTION/MANUAL_RENEWAL/BILLING_PLAN)

catalogId
any

Filter orders by catalogId

consentId
any

Filter orders by consentId

billingPlanId
any

Filter orders by billingPlanId

billingPlanPeriod
any

Filter orders by billingPlanPeriod You can use date ranges by using < or << operator, examples: billingPlanPeriod=XXXX< will return orders starting after XXXX, billingPlanPeriod=<XXXX will return orders starting before XXXX, billingPlanPeriod=XXXX<<YYYYY will return orders starting between XXXX and YYYY

lifeCycleStatus
any

Filter orders by status (PREBILLING_PENDING/PREBILLING_FAILED/PREBILLING_FAILED/WAITING_FOR_PAYMENT/PARTIAL_COMPLETED/PAYMENT_PENDING/INVOICE_PENDING/ENDUSER_PENDING/SUBSCRIPTION_PENDING/FULFILLMENT_PENDING/EMAILCONFIRMATION_PENDING/COMPLETED_WITH_ERROR/COMPLETED/CANCEL_PENDING/CANCELED_WITH_ERROR/CANCELED/FORCE_COMPLETED/FORCE_CANCELED/FORCE_ABORTED)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
allowPaymentMethodRegistration
boolean

Payment method registration authorized

cartId
string

Reference ID of cart service

cartVersion
integer <int64>

Cart version

endUserId
string

Reference ID of the end-user

endUserIp
string

End-user IP used during purchase

generationId
string

Declarative reference ID of the generation of the subscription

layout
string

Define if we used a subscription layout on cart

layoutName
string

Real layout name defined in NC

paymentDeadline
integer <int64>

Payment deadline (timestamp)

paymentMethodId
string

Payment method reference ID of end-user wallet payment method to use to process payment

previousOrderId
string

Previous order reference ID to re-use payment method to process payment

subscriptionId
string

Reference ID of subscription service

subscriptionLayout
boolean

Only used for receipt confirmation if true

subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"

Purchase's sub source

withPrebilling
boolean

Request pre-billing step execution

Responses

Request samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": true,
  • "cartId": "string",
  • "cartVersion": 0,
  • "endUserId": "string",
  • "endUserIp": "string",
  • "generationId": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "paymentDeadline": 0,
  • "paymentMethodId": "string",
  • "previousOrderId": "string",
  • "subscriptionId": "string",
  • "subscriptionLayout": true,
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "withPrebilling": true
}

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Update one line item data

Authorizations:
Bearer
path Parameters
lineItemDataId
required
string
query Parameters
reason
string
Default: "resource update thru REST Api"
Request Body schema: application/json
required
Array
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update one sub line item data

Authorizations:
Bearer
path Parameters
lineItemDataId
required
string
subLineItemDataId
required
string
query Parameters
reason
string
Default: "resource update thru REST Api"
Request Body schema: application/json
required
Array
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Start order migration

Authorizations:
Bearer
query Parameters
reason
string
Default: "migration thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Start order migration by timeframe

Authorizations:
Bearer
path Parameters
startDate
required
string
endDate
required
string
query Parameters
reason
string
Default: "migration thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Start order migration by timeframe

Authorizations:
Bearer
path Parameters
endDate
required
string
query Parameters
reason
string
Default: "migration thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Start order migration by timeframe

Authorizations:
Bearer
path Parameters
orderId
required
string
query Parameters
reason
string
Default: "migration thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Release lock on migration procedure

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Resync order v2 to v1

Authorizations:
Bearer
path Parameters
orderId
required
string
query Parameters
reason
string
Default: "sync thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Create a subscription order Deprecated

Authorizations:
Bearer
query Parameters
reason
string
Default: "resource creation thru REST Api"
Request Body schema: application/json
required
Array of objects (LineItemData)
object (Order)

Responses

Request samples

Content type
application/json
{
  • "lineItemDataList": [
    ],
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Get order by subscriptionId and generation

return order by subscriptionId and generation, if generation is not provided it return the last order attached to the subscriptionId

Authorizations:
Bearer
path Parameters
subscriptionId
required
string
query Parameters
generation
string

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Get subscription renewal price (applicable before the prebilling )

Authorizations:
Bearer
Request Body schema: application/json
required
generation
string
object (Subscription)

Responses

Request samples

Content type
application/json
{
  • "generation": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "currency": {
    },
  • "discountedPrice": {
    },
  • "grossPrice": 0.1,
  • "initialGrossPrice": 0.1,
  • "initialNetPrice": 0.1,
  • "initialVatAmount": 0.1,
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "netPrice": 0.1,
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "strikeThroughPrice": 0.1,
  • "vatAmount": 0.1,
  • "vatIncluded": true,
  • "vatRate": 0.1
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

getOrders

Authorizations:
Bearer
query Parameters
required
object (OrderCriteria)
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

viewRemittableUnpayoutableBalance

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getOldestOrderBySubscriptionId

Authorizations:
Bearer
path Parameters
subscriptionId
required
string
query Parameters
lifeCycleStatus
required
string
Enum: "PREBILLING_PENDING" "PREBILLING_FAILED" "WAITING_FOR_PAYMENT" "PAYMENT_PENDING" "INVOICE_PENDING" "ELECTRONIC_INVOICE_PENDING" "ENDUSER_PENDING" "SUBSCRIPTION_PENDING" "FULFILLMENT_PENDING" "EMAILCONFIRMATION_PENDING" "COMPLETED_WITH_ERROR" "COMPLETED" "CANCEL_PENDING" "CANCELED_WITH_ERROR" "CANCELED" "FORCE_COMPLETED" "FORCE_CANCELED" "FORCE_ABORTED"
generationId
string

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

getOrderSummary

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "consentId": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "enduserId": "string",
  • "exportActivationCodeFileUrl": "string",
  • "fullCreditNodeId": "string",
  • "fullTotalAmount": {
    },
  • "id": "string",
  • "initialCurrency": {
    },
  • "invoiceId": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "products": [
    ],
  • "status": "CANCELED_WITH_ERROR",
  • "storeId": "string",
  • "subscriptionId": "string"
}

findPreviousGenerationLineItemByOrderAndSubscription

Authorizations:
Bearer
path Parameters
orderId
required
string
subscriptionId
required
string

Responses

Response samples

Content type
application/json
{
  • "activationLink": {
    },
  • "amount": 0.1,
  • "businessSegment": "string",
  • "currency": {
    },
  • "customFieldsId": "string",
  • "discountAmount": 0.1,
  • "discountPlan": {
    },
  • "discountRate": 0.1,
  • "emailDesc": "string",
  • "existingLicenseId": "string",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "fraudPoints": 0,
  • "fulfillmentTemplate": "string",
  • "fulfillmentTemplateName": "string",
  • "id": "string",
  • "initialAmount": 0.1,
  • "initialNetAmount": 0.1,
  • "initialVatAmount": 0.1,
  • "licenseId": "string",
  • "licenseNextExpirationDate": "string",
  • "lifeTime": "string",
  • "longDesc": "string",
  • "multipleLicensesFulfillment": true,
  • "name": "string",
  • "netAmount": 0.1,
  • "numberOfDaysBeforeRenewalRemote": 0,
  • "physical": true,
  • "price": {
    },
  • "priceFunctionParameters": {
    },
  • "productFamily": "string",
  • "productId": "string",
  • "productType": "string",
  • "publisherRefId": "string",
  • "quantity": 0,
  • "relatedContents": [
    ],
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "remoteLicenseExpirationDate": "2019-08-24T14:15:22Z",
  • "renewingPrice": {
    },
  • "renewingProductDetails": {
    },
  • "shortDesc": "string",
  • "signedProduct": "string",
  • "subscriptionTemplate": "string",
  • "taxCode": "string",
  • "taxExempt": true,
  • "thankYouDesc": "string",
  • "trial": true,
  • "trialDuration": 0,
  • "unitPrice": {
    },
  • "variablesDetails": {
    },
  • "vatAmount": 0.1,
  • "vatRate": 0.1
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Add event to order

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
dbVersion
integer <int64>
reason
string
Default: "additional event thru REST Api"
Request Body schema: application/json
required
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Resend email of the order

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
reason
string
Default: "send email thru REST Api"
Request Body schema: application/json
required
cancellationReason
string

Cancellation reason

paymentId
string

Payment id

preorderProductId
string

Product if the email is about specific product (preorder case)

Responses

Request samples

Content type
application/json
{
  • "cancellationReason": "string",
  • "paymentId": "string",
  • "preorderProductId": "string"
}

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Cancel completely an order

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
dbVersion
required
integer <int64>
cancellationReason
string
Default: "OCL"
reason
string
Default: "full cancel thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Prepare an order for repair

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
reason
string
Default: "preparation for repair thru REST Api"
Request Body schema: application/json
required
object (EndUser)

End-user information

object (ResetFulfillmentCancellationRequest)
resetInvoice
boolean
resyncCustomer
boolean
resyncEndUser
boolean
resyncProducts
boolean
resyncStore
boolean
subsidiaryId
string^[0-9]{1,3}$
updateEndUser
boolean
updateLayout
boolean
object (UpdateLayoutRequest)
object (UpdatePaymentDeadlineRequest)

Responses

Request samples

Content type
application/json
{
  • "endUser": {
    },
  • "resetFulfillmentCancellationRequest": {
    },
  • "resetInvoice": true,
  • "resyncCustomer": true,
  • "resyncEndUser": true,
  • "resyncProducts": true,
  • "resyncStore": true,
  • "subsidiaryId": "string",
  • "updateEndUser": true,
  • "updateLayout": true,
  • "updateLayoutRequest": {
    },
  • "updatePaymentDeadlineRequest": {
    }
}

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Repair an order

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
dbVersion
required
integer <int64>
forceRepair
boolean
Default: false
reason
string
Default: "repair thru REST Api"

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Resync endUser info in order

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Update one line item in order

Authorizations:
Bearer
path Parameters
orderId
required
string
lineItemId
required
string
query Parameters
reason
string
Default: "resource update thru REST Api"
Request Body schema: application/json
required
Array
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Update one sub line item in order

Authorizations:
Bearer
path Parameters
orderId
required
string
lineItemId
required
string
subLineItemId
required
string
query Parameters
reason
string
Default: "resource update thru REST Api"
Request Body schema: application/json
required
Array
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

findPreviousGenerationOrderByOrderAndSubscription

Authorizations:
Bearer
path Parameters
orderId
required
string
subscriptionId
required
string

Responses

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

Update processing events list

Authorizations:
Bearer
path Parameters
orderId
required
string
Request Body schema: application/json
required
Array
object
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "allowPaymentMethodRegistration": false,
  • "avaTaxStatus": "NONE",
  • "billingPlanId": "25aaceea-5a34-11eb-ae93-0242ac130002",
  • "billingPlanPeriod": "2023-12",
  • "cancelPeriod": 14,
  • "cartId": "f3fb782e-5969-11eb-ae93-0242ac130002",
  • "cartIp": "127.0.0.1",
  • "catalogId": "88960ca8-5af8-11eb-ae93-0242ac130002",
  • "consentFlags": {
    },
  • "consentId": "64f2d71c-5af9-11eb-ae93-0242ac130002",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNotes": [
    ],
  • "currency": "EUR, USD, GBP ...",
  • "currencyFormatVariation": "DEFAULT, SYMBOL_LEFT",
  • "customer": {
    },
  • "customerName": "string",
  • "dbVersion": 0,
  • "electronicInvoiceStatus": "NONE",
  • "emailCancellationStatus": "NONE",
  • "emailConfirmationStatus": "NONE",
  • "emails": [
    ],
  • "endUser": {
    },
  • "endUserCreationStatus": "NONE",
  • "endUserIp": "127.0.0.1",
  • "externalContext": "myExternalContext",
  • "fulfillmentStatus": "NONE",
  • "fullCreditNoteStatus": "NONE",
  • "fullTotalAmount": {
    },
  • "generationId": "1",
  • "geoZones": "Africa",
  • "id": "string",
  • "initialCurrency": "EUR, USD, GBP ...",
  • "invoice": {
    },
  • "invoiceStatus": "NONE",
  • "lastUpdateReason": "string",
  • "layout": "string",
  • "layoutName": "string",
  • "lifeCycleStatus": "PREBILLING_PENDING",
  • "lineItems": [
    ],
  • "marketingCampaignNames": [
    ],
  • "maxPaymentsParts": 1,
  • "minPartialPaymentAmount": 5,
  • "modelVersion": "string",
  • "numberOfInstallments": 1,
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "https://my.website.com/confirmation",
  • "parentOrderId": "2G4NAYY4K23",
  • "payment": {
    },
  • "paymentDeadline": 1616143889109,
  • "paymentDeadlineReached": true,
  • "paymentOfflineReminderSent": true,
  • "paymentStatus": "NONE",
  • "payments": [
    ],
  • "prebillingStatus": "NONE",
  • "promoteOneClickPayment": false,
  • "registerPaymentMethodStatus": "NONE",
  • "remainingTotalAmount": 0.1,
  • "remitteds": [
    ],
  • "salesFlag": "string",
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER | UPGRADE",
  • "status": "CANCELED_WITH_ERROR",
  • "store": {
    },
  • "storeHostname": "mystore.nexway.com",
  • "subscriptionId": "119e3e2a-596a-11eb-ae93-0242ac130002",
  • "subscriptionLayout": true,
  • "subscriptionStatus": "NONE",
  • "subscriptionSubSource": "TRIAL_CONVERSION | RENEWAL",
  • "subsidiaryId": "d4beee32-5969-11eb-ae93-0242ac130002",
  • "taxDeclaration": {
    },
  • "taxTransactionId": "288d5056-d9c5-46c7-b7d8-954f45f399a4",
  • "taxTypes": [
    ],
  • "testOrder": false,
  • "totalAmount": 102.5,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "vatRate": 0.2,
  • "warnings": [
    ]
}

CancellationReason

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
cancellationReasonId
integer <int32>
comment
string
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
label
required
string
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
trigram
required
string = 3 characters
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get a cancellation reason

Get a cancellation reason with public access, by id or cancellationReasonId

Authorizations:
Bearer
path Parameters
cancellationReasonId
required
string
Example: 7d180bdd-3d82-41f5-8159-f0ab22ffb266 or an integer

id or cancellationReasonId

Responses

Response samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
cancellationReasonId
integer <int32>
comment
string
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
label
required
string
lastUpdateReason
string
modelVersion
string
Deprecated
originalId
string
trigram
required
string = 3 characters
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "originalId": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "cancellationReasonId": 0,
  • "comment": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "label": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "trigram": "str",
  • "updateDate": "2019-08-24T14:15:22Z"
}

customFields

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "productCustomFields": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
createDate
string <date-time>
Deprecated
dbVersion
integer <int64>
id
string
Deprecated
lastUpdateReason
string
modelVersion
string
Deprecated
orderId
string
originalId
string
Array of objects (CartProductCustomFields)
updateDate
string <date-time>
Deprecated

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "originalId": "string",
  • "productCustomFields": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "productCustomFields": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z"
}

ProcessingEventHistory

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "event": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

LineItemData

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string
endUser.email
any

Filter lineItems by endUser email

endUser.country
any

Filter lineItems by endUser country

endUser.accountCreated
any

Filter lineItems by endUser accountCreated

customer.id
any

Filter lineItems by customer id

id
any

Filter lineItem id

lineItemId
any

Filter lineItem by lineItemId

orderId
any

Filter lineItem by orderId

subLineItemsData
any

Filter lineItemData by subLineItemData flag

subscriptionId
any

Filter lineItem subscriptionId

nexwayFulfillmentId
any

Filter by lineItem nexwayFulfillmentId

publisherFulfillmentId
any

Filter lineItem publisherFulfillmentId

activationCode
any

Filter lineItem activationCode

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get line items data by orderId

Authorizations:
Bearer
path Parameters
orderId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get line item data by orderId and compatId or id

Authorizations:
Bearer
path Parameters
orderId
required
string
compatId
required
string

Responses

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Get line item data by orderId and compatId or id includes sub line item data

Authorizations:
Bearer
path Parameters
orderId
required
string
compatId
required
string

Responses

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Count line item data by orderId and predicate

Authorizations:
Bearer
path Parameters
orderId
required
string
query Parameters
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "activationCode": "string",
  • "activationFileFulfillment": true,
  • "activationLink": "string",
  • "compatId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "creditNoteProcessingStatus": "NONE",
  • "customerId": "string",
  • "dbVersion": 0,
  • "enduserId": "string",
  • "fulfillmentOperationId": "string",
  • "fulfillmentProcessingStatus": "NONE",
  • "id": "string",
  • "lastUpdateReason": "string",
  • "lineItemId": "string",
  • "modelVersion": "string",
  • "nexwayFulfillmentId": "string",
  • "orderId": "string",
  • "preorderReleaseNotificationNeeded": true,
  • "previousLineItemDataId": "string",
  • "processingEvent": [
    ],
  • "processingStatus": "CANCELED",
  • "productId": "string",
  • "publisherFulfillmentId": "string",
  • "qrCodeBase64": "string",
  • "reminderDays": 7,
  • "subscriptionId": "string",
  • "subscriptionProcessingStatus": "NONE",
  • "updateDate": "2019-08-24T14:15:22Z"
}

ApiPublicCommand

Get order public details by order ID

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "Initial currency requested, before conversion": {
    },
  • "Order currency": {
    },
  • "Order id": "string",
  • "Order products": [
    ],
  • "Order status": "CANCELED_WITH_ERROR",
  • "Order total amount": 0.1,
  • "fullTotalAmount": {
    }
}

Get custom fields

Get custom fields by order ID

Authorizations:
Bearer
path Parameters
orderId
required
string

filter by order ID

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "id": "string",
  • "lastUpdateReason": "string",
  • "modelVersion": "string",
  • "orderId": "string",
  • "productCustomFields": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z"
}

search

Authorizations:
Bearer
query Parameters
required
object (Pageable)
required
object (MultiValueMapStringString)

Responses

Response samples

Content type
application/json
"string"

attributePattern

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

computeAttributePattern

Authorizations:
Bearer
Request Body schema: application/json
required
fromDate
string <date-time>
orderIds
Array of strings
toDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "orderIds": [
    ],
  • "toDate": "2019-08-24T14:15:22Z"
}

resetAttributePattern

Authorizations:
Bearer
Request Body schema: application/json
required
fromDate
string <date-time>
orderIds
Array of strings
toDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "orderIds": [
    ],
  • "toDate": "2019-08-24T14:15:22Z"
}