Register delivery stops

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

Stop API for stopping delivery to a customer permanently or temporary.

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/product/stop/delivery' \ --header 'Content-Type: application/json' \ --data-raw '{ "deliveryStop": { "id": 1, "product": "CO27409", "stopTime": 1561121761000, "stopEndTime": 1561985761000, "stopType": "temporary", "deliveryStopChannel": "EMAIL", "deliveryStopReason": "BS" } }'

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

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

Body Params application/json

deliveryStop

object

optional

integer

optional

Unique id for this stop, change existing stop if id is given

product

string

required

Product to be stopped

<= 12 characters

stopTime

integer

required

When to stop delivery.

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

stopEndTime

integer

optional

When to start after a stop period. Required when stopType is not permanent.

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

stopType

enum<string>

required

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. A digital product will be started in the stop 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

Examples

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

🟠429Too Many Requests

🔴500Server Error