Provide nexway with the necessary information to send a quote to an end-user
POST https://api.nexway.store/quotes
The request body takes a complete EndpointQuoteParameter resource, containing the following writable properties:
{
"metadata": {
"dataAcquisitionTime": "int64",
"nexwaySalesunitID": "string",
"originStore": "string",
"siteLanguage": "string"
},
"quote": {
"currency": "string",
"items": [
{
"pricing": {
"VATRate": "float",
"discountConstant": "float",
"discountRate": "float",
"unitPriceExclVAT": "float",
"unitPriceExclVATDiscounted": "float",
"unitPriceIncVAT": "float"
},
"product": {
"NexwayID": "string",
"name": "string",
"seasonality": "string",
"uniqueReference": "string"
},
"quantity": "integer"
}
],
"mailConfig": {
"campaignExternalId": "string",
"campaignName": "string",
"from": "/\\A([\\w+\\-](\\.[\\w+\\-])?)+@[a-z\\d\\-]+(\\.[a-z]+)*\\.[a-z]+\\z/i",
"replyTo": "/\\A([\\w+\\-](\\.[\\w+\\-])?)+@[a-z\\d\\-]+(\\.[a-z]+)*\\.[a-z]+\\z/i",
"secondarySubject": "string",
"sendingExternalId": "string",
"subject": "string",
"templateExternalId": "string"
},
"requester": "string",
"siteCountry": "string"
},
"user": {
"address": "string",
"city": "string",
"companyName": "string",
"country": "string",
"email": "/\\A([\\w+\\-](\\.[\\w+\\-])?)+@[a-z\\d\\-]+(\\.[a-z]+)*\\.[a-z]+\\z/i",
"firstName": "string",
"language": "string",
"lastName": "string",
"phoneNumber": "string",
"state": "string",
"title": "string",
"zipcode": "string"
}
}
Name | Type | Description | Additional |
---|---|---|---|
metadata | object |
information about the data you transmit |
Optional |
metadata.dataAcquisitionTime | int64 |
when the data has been acquired, elapsed seconds since Jan, 1st 1970 UTC. If unknown do no provide this field or set it to 0. |
Optional |
metadata.nexwaySalesunitID | string |
An id identifying the point of sales (or service) in Nexway System. Make sure you know the proper ID(s) before sending your message , if you don't contact your POC at Nexway to get the IDs. |
Optional |
metadata.originStore | string |
A string identifying the source of the message. The format is free (as far as this API is concerned), and should be created following a convention between the client and Nexway (Contact agency_dm@nexway.com in doubts). |
Optional |
metadata.siteLanguage | string | Optional | |
quote | object |
describes the information needed for a quote |
Optional |
quote.currency | string | Optional | |
quote.items[] | array | Optional | |
quote.items[].pricing | object | Pricing | |
quote.items[].pricing.VATRate | float |
the VAT rate, if given, must be the tax ratio, for instance 0.2 is VAT is 20% |
|
quote.items[].pricing.discountConstant | float |
the discount constant value |
|
quote.items[].pricing.discountRate | float |
the discount rate, for instance 0.1 is discount rate is 10% |
|
quote.items[].pricing.unitPriceExclVAT | float | ||
quote.items[].pricing.unitPriceExclVATDiscounted | float |
Unit price without VAT with discount applied |
Optional |
quote.items[].pricing.unitPriceIncVAT | float | ||
quote.items[].product | object |
A product definition in a quote. |
|
quote.items[].product.NexwayID | string |
Nexway ID of the product |
Optional |
quote.items[].product.name | string |
human-readable name of the product, it is not required to be immutable regarding the product id, especially considering translations. |
|
quote.items[].product.seasonality | string |
monthly , yearly or none |
Optional |
quote.items[].product.uniqueReference | string |
A unique identifier for the product. This id must be uniquely attached to a product in your information system, and be eternally immutable. |
|
quote.items[].quantity | integer |
The number of products that was ordered |
|
quote.mailConfig | object | MailConfig | Optional |
quote.mailConfig.campaignExternalId | string |
ex : RT-MyCompany_DE_quote2cash - CHANGE WITH THE GOOD COUNTRY CODE FOR EACH SITE |
Optional |
quote.mailConfig.campaignName | string |
ex : RT-MyCompany_DE_quote2cash - CHANGE WITH THE GOOD COUNTRY CODE FOR EACH SITE |
Optional |
quote.mailConfig.from | /\A([\w+\-](\.[\w+\-])?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i | ||
quote.mailConfig.replyTo | /\A([\w+\-](\.[\w+\-])?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i | ||
quote.mailConfig.secondarySubject | string | Optional | |
quote.mailConfig.sendingExternalId | string |
ex : RT-YYYYMMJJ - UPDATE WITH SENDING DATE |
Optional |
quote.mailConfig.subject | string | ||
quote.mailConfig.templateExternalId | string |
ex : T-3 - language template per country-language |
Optional |
quote.requester | string |
Optional field to transmit requester ID for this quote |
Optional |
quote.siteCountry | string | Optional | |
user | object | User | Optional |
user.address | string |
street number and street name, may contain unix EOL characters (ascii 0x0A). |
Optional |
user.city | string | Optional | |
user.companyName | string | Optional | |
user.country | string | Optional | |
user.email | /\A([\w+\-](\.[\w+\-])?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i | ||
user.firstName | string | ||
user.language | string | Optional | |
user.lastName | string | ||
user.phoneNumber | string | Optional | |
user.state | string | Optional | |
user.title | string |
title as entered by the end-user in its language |
|
user.zipcode | string | Optional |
This request requires the use of one of following authorisation methods:
BASIC
.
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
204 | No Content request correctly processed, thank you |
|
400 | Bad Request The provided data do not meet requirements |
|
401 | Unauthorized Please authenticate |
|
500 | Internal Server Error Internal error |
|
503 | Service Unavailable Service is unavailable, please retry later |