Versions Compared

Old Version 3

changes.mady.by.user Roar Granevang

Saved on

compared with

New Version Current

changes.mady.by.user Mathias Rafn

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

{{base_url_ws}} is https://ws.di.no for production and , https://devstg-ws.di.no for dev
There is a postman suite at / for stage andhttps://distributiondev-innovationws.postman.co/workspace/media~30a1f505-d258-4c56-8b0d-99ec53518197/collection/20709994-ae2764d1-8d8d-46e7-b754-a1397a950a45?action=share&creator=20709994di.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

Code Block
{
    "username": "
wsaftonbladet
username",
    "password": "passphrase"
}

Code Block
{
    "token": "bearertokenstring"
}

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/start

POST

Give DI notice that you will start sending delivery amounts for a product

Code Block
{
    "productNameExternal": "
OR
EXP",
    "date": "2023-03-01"
}

Code Block
{
    "status": "ok"
}

{{base_url_ws}}/ws/json/retailer/aftonbladet/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.

Code Block
{
    "fsstNumber": 999999,
    "productNameExternal": "
OR
EXP",
    "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
        }                                                  
    ]
}

Code Block
{
    "status": "ok"
}

{{base_url_ws}}/ws/json/retailer/aftonbladet/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.

Code Block
{
    "productNameExternal": "
OR
EXP",
    "date": "2023-03-05"
}

Code Block
{
    "status": "ok"
}

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/retailerStatistics

GET

Get how many papers have been delivered and returned in the last x days.

historyDays=790&productNameExternal=OR&productNameExternal=AB39&fsstNumber=15454

Code Block
[
    {
        "fsstNumber":
15454
999999,
        "productName": "
OR
EXP",
        "delivered": 6,
        "returned": 2,
        "soldFrom": "
2020
2023-
12
03-
29
05"
    },
    {
        "fsstNumber":
15454
999999,
        "productName": "
OR
EXP",
        "delivered": 5,
        "returned": 4,
        "soldFrom": "
2020
2023-
12
06-
30
03"
    },
]

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/retailerStatisticsAggregated

POST

Get aggregated deliveries and returns data for multiple retailers.

Code Block
{
    "fsstNumbers": [
15454
999998,999999],
    "productNamesList": ["
OR
EXP", "
AB3
EXLP"],
    "fromDate": "2023-
01
03-01",
    "toDate": "2023-
02
04-01"
}

Code Block
[
    {
        "productId":
2184
9999,
        "productName": "
OR
EXP",
        "deliveriesInTotal": 3,
        "deliveriesToFsstsWithConfirmedReturns": 3,
        "confirmedReturns": 2,
        "soldFrom": "2023-
01
03-03"
    },
    {
        "productId":
2184
9999,
        "productName": "
OR
EXP",
        "deliveriesInTotal": 3,
        "deliveriesToFsstsWithConfirmedReturns": 3,
        "confirmedReturns": 3,
        "soldFrom": "2023-03-05"
    }
]

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/activeRetailers

GET

Get a list of fsst-numbers with autoreg=1 that are active x number of days from now

daysFromNow=10

Code Block
"fsstNumbers": [
        999996,
        999997,
        999998,
        999999
   ]
}

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/releasedProducts

GET

Get EXP products that have a release the given day according to ProduktUtgivelse

releaseDate=2023-01-23

Code Block
[
    {
        "productId": "EXP",
        "releaseDate": "2023-03-03",
        "saleDayCount": 1,
        "price": 29.0
    },
    {
        "productId": "EXLP",
        "releaseDate": "2023-03-05",
        "saleDayCount": 7,
        "price": 33.9
    }
]

{{base_url_ws}}/ws/json/retailer/aftonbladet/v-1/activeProducts

GET

Get EXP products that are currently active and what the current price is.

Code Block
{
    {
        "productId": "EXP",
        "productType": "TIDN",
        "productName": "EX Expressen",
        "price": 29.0
    },
    {
        "productId": "EXLP",
        "productType": "TIDN",
        "productName": "EX Expressen lokallöp",
        "price": 29.0
    }
}