Connect

List delivery stops

Production

https://api.mediaconnect.no/capi

GET

/v1/product/stop/delivery/{productCode}

DeliveryStop

The user needs to be logged in to use this endpoint, click here to read more.

API is used to get stop registered on customer.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/product/stop/delivery/'

Response Example

200 - Success

{
    "deliveryStops": [
        {
            "id": 1,
            "product": "CO27409",
            "stopTime": 1561121761000,
            "stopEndTime": 1561985761000,
            "stopType": "temporary",
            "deliveryStopChannel": "BS",
            "deliveryStopReason": "CS"
        }
    ]
}

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Path Params

productCode

string

required

Product code

<= 12 characters

Responses

🟢200OK

application/json

Body

deliveryStops

array [object {7}]

optional

integer

optional

Unique id for this stop

product

string

optional

Product code

<= 12 characters

stopTime

integer

optional

Time to stop

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

stopEndTime

integer

optional

Time to start after a stop period

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC..

stopType

enum<string>

optional

Permanent or temporary stop. Stop type to be used:

permanent: permanent stop

temporary: temporary stop

donation: donation stop, i.e somebody else is getting product in stop period

storing: storing stop, i.e issues in period will be post distributed

noDelivery: no delivery, i.e issues in period will not be distributed and no extension of paid period.

Allowed values:

permanenttemporarydonationstoringnoDelivery

deliveryStopChannel

string

optional

The stop channel-code for the stop (Ex. "CS", "EMAIL","INV"...)

<= 12 characters

deliveryStopReason

string

optional

The stop reason-code for the stop (Ex. "BS", "DS", "MO"...)

<= 2 characters

🟠400Bad Request

🟠429429

🔴500Server Error

List delivery stop - client mode