Retailer endpoints (NPS)
- Mathias Rafn
Analytics
{{base_url_ws}} is https://ws.di.no for production, https://stg-ws.di.no/ for stage and https://dev-ws.di.no for dev
Endpoint | Method | Description | Example payload/parameters | Example response |
|---|---|---|---|---|
{{base_url_ws}}/ws/json/auth/v-3/login/600 | POST | Login with DI ws-user and receive a bearer token | {
"username": "username",
"password": "passphrase"
}Β | {
"token": "bearertokenstring"
}Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/start | POST | Give DI notice that you will start sending delivery amounts for a product | {
"productId": XXX,
"date": "2023-03-01"
}Β | {
"status": "ok"
}Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/updateForecast | POST | Send an array of delivery amounts for product and days. Retailer has to have autoreg = true in the DI retailer-system. Note that demand and spread is ignored. | {
"retailerId": XXXXX,
"productId": YYY,
"resellerEditions": [
{
"date": "2023-03-01",
"demand": 4.0,
"delivery": 4.0,
"spread": 0.0
},
{
"date": "2023-03-02",
"demand": 5.0,
"delivery": 5.0,
"spread": 0.0
},
{
"date": "2023-03-03",
"demand": 6.0,
"delivery": 6.0,
"spread": 0.0
}
]
}Β | {
"status": "ok"
}Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/end | POST | Give DI notice that you have stopped sending delivery amounts for a product. This will also truncate logs older than 2 days. | {
"productId": "XXX",
"date": "2023-03-05"
}Β | {
"status": "ok"
}Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/retailerStatistics | GET | Get how many papers have been delivered and returned in the last x days. | historyDays=790&productId=XXX&productId=YYY&retailerId=ZZZZZ | [
{
"fsstNumber": 999999,
"productName": "XXX",
"delivered": 6,
"returned": 2,
"soldFrom": "2023-03-05"
},
{
"fsstNumber": 999999,
"productName": "YYY",
"delivered": 5,
"returned": 4,
"soldFrom": "2023-06-03"
},
] Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/retailerStatisticsAggregated | POST | Get aggregated deliveries and returns data for multiple retailers. | {
"fsstNumbers": [999998,999999],
"productIdsList": ["XXX", "YYY"],
"fromDate": "2023-03-01",
"toDate": "2023-04-01"
}Β | [
{
"productId": 9999,
"productName": "XXX",
"deliveriesInTotal": 3,
"deliveriesToFsstsWithConfirmedReturns": 3,
"confirmedReturns": 2,
"soldFrom": "2023-03-03"
},
{
"productId": 9999,
"productName": "YYY",
"deliveriesInTotal": 3,
"deliveriesToFsstsWithConfirmedReturns": 3,
"confirmedReturns": 3,
"soldFrom": "2023-03-05"
}
] Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/activeRetailers | GET | Get a list of Retailer IDβs with autoreg=1 that are active x number of days from now | daysFromNow=10&productId=XXX | "retailers": [
{
"retailerId": XXXXX,
"county": "ΓSTFOLD"
},
{
"retailerId": YYYYYY,
"county": "VESTLAND"
},Β |
{{base_url_ws}}/ws/json/retailer/nps/v-1/releasedProducts | GET | Get products that have a release the given day according to ProduktUtgivelse | releaseDate=2023-01-23&productId=XXX | [
{
"productId": "XXX",
"releaseDate": "2023-03-03",
"saleDayCount": 1,
"price": 29.0
},
{
"productId": "YYY",
"releaseDate": "2023-03-05",
"saleDayCount": 7,
"price": 33.9
}
]Β |
Β