MediaConnect AS
Powered by Redocly

Order

List orders

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

Use this API to get a list of orders with basic status.

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/order/status
Request samples 
Response samples 
application/json
{
  • "orders": [
    ]
}
Search order details
The user needs to be logged in to use this endpoint, click here to read more.


API to get detailed information for a given orderId or orders with the same externalOrderId. Note that only one value may be present in the request.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
orderId
integer
Mediaconnect ConnectID order id


 
externalOrderId
string  <= 40 characters 
External order id provided by client


 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/order/status
Request samples 
application/json
{
  • "orderId": 9,
  • "externalOrderId": "2342"
}
Response samples 
application/json
{
  • "orders": [
    ]
}
List order product history
The user needs to be logged in to use this endpoint, click here to read more.


Use this API to get a list of purchase history on order product (enkeltordre)


SecurityAuthorization_Code 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/customer/order/product/history
Request samples 
Response samples 
application/json
{
  • "orders": []
}
List order status - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


Use this API to get basic status regarding an order.


SecurityClient_Credentials 
Request 
path Parameters
orderId
required
string
ConnectID order id is used to identify an order.


 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/client/order/status/{orderId}
Request samples 
Response samples 
application/json
{
  • "orders": [
    ]
}
Register customer - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


API for creating a customer.


Commonly required fields:


    

  • companyName or lastName
    • 

  • postalCode
    • 

  • emails or phoneNumbers
    • 



SecurityClient_Credentials 
Request 
Request Body schema: application/json
companyRegistrationNumber
string  <= 16 characters 
A valid registration number in an official registry


 
companyName
string  <= 40 characters 
Name of the company


 
departmentName
string  <= 40 characters 
Name of the department


 
personsSocialSecurityNumber
string  <= 16 characters 
A valid personal social security number


 
firstName
string  <= 30 characters 
First name


 
middleName
string  <= 30 characters 
Middle name


 
lastName
string  <= 30 characters 
Last name


 
careOfAddress
string  <= 40 characters 
Extra address line if needed


 
street
string  <= 40 characters 
Street address


 
streetNumber
integer
Street number


 
entrance
string  <= 12 characters 
Entrance


 
floorType
string  <= 1 characters 
Valid values:


    

  • H: Main floor
    • 

  • U: Lower floor
    • 

  • L: Attic
    • 

  • K: Basement
    • 



 
floor
integer
Floor


 
suite
string  <= 10 characters 
Suite


 
postalCode
string  <= 10 characters 
A valid postal code for the street address


 
postalPlace
string  <= 30 characters 
Postal place


 
postalAddress
string  <= 40 characters 
Postal address


 
postalAddressPostalCode
string  <= 10 characters 
A valid postal code for the postal address


 
postalAddressPostalPlace
string  <= 30 characters 
Postal place for the postal address.


 
countryCode
string  <= 3 characters 
The country code for this address - ISO 3166 - alpha-2


 
birthDate
integer
Birth date if this is a person.


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


 
sex
string
Valid values


    

  • male: The person is a male.
    • 

  • female: The person is a female.
    • 

  • unknown: The gender is unknown.
    • 



 Enum: "male" "female" "unknown"  
emails
Array of strings <email>   [ 0 .. 2 ] items 
A list of email addresses beloning to the person or company. 0, 1 or 2 addresses (each address maximum 255 characters)


 
phoneNumbers
Array of strings  <= 4 items 
A list of phone numbers. Up to four phone numbers may be submitted.


A phone number has to follow the telephone number standard E.164


 
Array of objects
Custom data possible to add to any address record. Valid categories are found through the different category APIs.


 
Array of objects
Permission data possible to add to any address record. Permissions is not a required element.


 
Array of objects
Privacy permission data possible to add to any address record. Privacy permissions are not a required.


 
Responses 
200
OK


Response Schema: application/json
orderId
integer
OrderId for created order.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/client/customer
Request samples 
application/json
{
  • "companyRegistrationNumber": "5646903690",
  • "companyName": "Company International Ltd",
  • "departmentName": "Support",
  • "firstName": "Ola",
  • "middleName": "Fjordstrand",
  • "lastName": "Nordmann",
  • "careOfAddress": "Nedre Vollsgate XII",
  • "street": "Grubbegata",
  • "streetNumber": 6,
  • "entrance": "A",
  • "floorType": "H",
  • "floor": 6,
  • "postalCode": 179,
  • "postalPlace": "Oslo",
  • "postalAddress": "Postboks 265 Økern",
  • "postalAddressPostalCode": "0510",
  • "postalAddressPostalPlace": "Oslo",
  • "countryCode": "NO",
  • "emails": [
    ],
  • "phoneNumbers": [
    ]
}
Response samples 
application/json
{
  • "orderId": 9
}
Register customer
The user needs to be logged in to use this endpoint, click here to read more.


API for creating a customer.


Commonly required fields:


    

  • companyName or lastName
    • 

  • postalCode
    • 

  • emails or phoneNumbers
    • 



SecurityAuthorization_Code 
Request 
Request Body schema: application/json
companyRegistrationNumber
string  <= 16 characters 
A valid registration number in an official registry


 
companyName
string  <= 40 characters 
Name of the company


 
departmentName
string  <= 40 characters 
Name of the department


 
personsSocialSecurityNumber
string  <= 16 characters 
A valid personal social security number


 
firstName
string  <= 30 characters 
First name


 
middleName
string  <= 30 characters 
Middle name


 
lastName
string  <= 30 characters 
Last name


 
careOfAddress
string  <= 40 characters 
Extra address line if needed


 
street
string  <= 40 characters 
Street address


 
streetNumber
integer
Street number


 
entrance
string  <= 12 characters 
Entrance


 
floorType
string  <= 1 characters 
Valid values:


    

  • H: Main floor
    • 

  • U: Lower floor
    • 

  • L: Attic
    • 

  • K: Basement
    • 



 
floor
integer
Floor


 
suite
string  <= 10 characters 
Suite


 
postalCode
string  <= 10 characters 
A valid postal code for the street address


 
postalPlace
string  <= 30 characters 
Postal place


 
postalAddress
string  <= 40 characters 
Postal address


 
postalAddressPostalCode
string  <= 10 characters 
A valid postal code for the postal address


 
postalAddressPostalPlace
string  <= 30 characters 
Postal place for the postal address.


 
countryCode
string  <= 3 characters 
The country code for this address - ISO 3166 - alpha-2


 
birthDate
integer
Birth date if this is a person.


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


 
sex
string
Valid values


    

  • male: The person is a male.
    • 

  • female: The person is a female.
    • 

  • unknown: The gender is unknown.
    • 



 Enum: "male" "female" "unknown"  
emails
Array of strings <email>   [ 0 .. 2 ] items 
A list of email addresses beloning to the person or company. 0, 1 or 2 addresses (each address maximum 255 characters)


 
phoneNumbers
Array of strings  <= 4 items 
A list of phone numbers. Up to four phone numbers may be submitted.


A phone number has to follow the telephone number standard E.164


 
Array of objects
Custom data possible to add to any address record. Valid categories are found through the different category APIs.


 
Array of objects
Permission data possible to add to any address record. Permissions is not a required element.


 
Array of objects
Privacy permission data possible to add to any address record. Privacy permissions are not a required.


 
Responses 
200
OK


Response Schema: application/json
orderId
integer
OrderId for created order.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/customer
Request samples 
application/json
{
  • "companyRegistrationNumber": "5646903690",
  • "companyName": "Company International Ltd",
  • "departmentName": "Support",
  • "firstName": "Ola",
  • "middleName": "Fjordstrand",
  • "lastName": "Nordmann",
  • "careOfAddress": "Nedre Vollsgate XII",
  • "street": "Grubbegata",
  • "streetNumber": 6,
  • "entrance": "A",
  • "floorType": "H",
  • "floor": 6,
  • "postalCode": 179,
  • "postalPlace": "Oslo",
  • "postalAddress": "Postboks 265 Økern",
  • "postalAddressPostalCode": "0510",
  • "postalAddressPostalPlace": "Oslo",
  • "countryCode": "NO",
  • "emails": [
    ],
  • "phoneNumbers": [
    ]
}
Response samples 
application/json
{
  • "orderId": 9
}
Register order - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


API for creating an order. The order can contain one or more lines. Each line may contain a receiver. If Marketing coupon is used both marketing coupon, i.e marketingCouponCode and marketingCouponNumber, fields are required.


There are several possible payment methods. Payment provider configuration is needed to use these payment methods, excluding free and invoice. In order to set up this configuration, please contact Mediaconnect by sending an email to Support at Mediaconnect. Some of the payment providers support recurring payment and prepayment, see the table below.


<

  

    paymentMethod
     recurring=true
    recurring=false
    prepaid=true
    prepaid=false
  

  

    invoice
    ✔
    ✔
    
    ✔
  

  

    sms (Link Mobility)
    ✔
    
    
    ✔
  

  

    smsPay
    
    ✔
    ✔
    
  

  

    vippsRecurring 
(Faste betalinger med Vipps)		
    ✔
    
    
    ✔
  

  

    kco (Klarna)
    ✔
    ✔
    ✔
    ✔
  

  

    creditcardPayex
    ✔
    ✔
    ✔
    ✔
  

  

    swishPayex
    
    ✔
    ✔
    ✔
  

    

    vippsEcommerce 
 (single payment)		
    
    ✔
    ✔
    ✔
  



   nexi
    ✔
    ✔
    ✔
    ✔
  

   other
    
    ✔
    ✔
    
  





Commonly required fields:


    

  • companyName or lastName
    • 

  • postalCode
    • 

  • emails or phoneNumbers
    • 



After placing an order to the client order API, the order needs to be fulfilled. This can be done either with a redirect or using an API call.
The specific use-case dictates whether how the fulfillment process can be performed. If the fulfillment includes an interactive payment process (e.g. card payment), the redirect must be used. If the order is prepaid, or does not involve the user for payment (e.g. invoice), the API for fulfillment may be used.


For the redirect case, the user must be redirected to the URL for fulfillment (https://connectid.no/user/fulfillment or https://connectid.se/user/fulfillment). Depending on the payment method on the order the user will be further redirected to an external payment service.
Read more about fulfillment URL.


The API endpoint for fulfillment is described here.


SecurityClient_Credentials 
Request 
Request Body schema: application/json
externalOrderId
string  <= 40 characters 
Order ID from the system delivering the order.


 
orderDate
required
integer
The date the order was placed in the external system.


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


 
paymentMethod
required
string
It is only allow to use these payment methods:


    

  • invoice: Paying by sending a invoice
    • 

  • free:  It is free of cost.
    • 

  • sms: Paying by using SMS via Link Mobility.
    • 

  • smsPay: Paying by using SMS via SMSpay.
    • 

  • masterpass: Paying by using a digital wallet provided by Mastercard.
    • 

  • vippsRecurring: Paying by using Vipps (Faste betalinger med Vipps).
    • 

  • kco: Paying by using Klarna Checkout.
    • 

  • creditcardPayex: Paying by using a credit card via Payex.
    • 

  • swishPayex: Paying by using Swish via Payex.
    • 

  • vippsEcommerce: Paying by using Vipps Ecommerce (single payment).
    • 

  • nexi: Paying by using Nexi.
    • 

  • other: Paying by using own integration with payment provider.
    • 



 Enum: "invoice" "free" "sms" "smsPay" "masterpass" "vippsRecurring" "kco" "creditcardPayex" "swishPayex" "vippsEcommerce" "nexi" "other"  
merchantId
string  <= 64 characters 
Unique ID that identify the payment provider.


 
orderAmount
required
number  decimal places <= 2 
Total amount for the entire order.


 
currency
required
string  <= 3 characters 
Currency for the entire order has to follow  the standard ISO4217 - alphabetic code.


 
marketingCouponCode
string  <= 12 characters 
Marketing coupon code to use in a e.g product order.


 
marketingCouponNumber
integer
Marketing coupon number to use in a e.g product order.


 
campaignParameters
string  <= 64 characters 
Field is related to lookup of market coupons. The value is a URL query param which points to a sales place.


 
companyCode
string  <= 12 characters 
Company code for the products in the order. Company code is used to find correct merchant etc for billing and such. If it is null client’s company code is used.


 
customerReference
string  <= 78 characters 
Customer reference number.


 
seller
string  <= 12 characters 
Seller code representing the salesperson who made this order come true.


 
salesMethod
string  <= 12 characters 
Method of sale


 
required
object (Name and address for payer) 
 
required
Array of objects
 
recurring
boolean
 Default:  true
It informs if recurring payment should be done on this order.


    

  • true: The recurring payment will be enabled if the payment provider support this and coupon/product allow to do the recurring payment.
    • 

  • false: The recurring payment will not be enabled. For one-time purchase needs to be false.
    • 



 
prepaid
boolean
 Default:  false
It informs if the order is prepaid.


    

  • true:  The order was prepaid. There is no need to do the payment.
    • 

  • false: The order is not prepaid.
    • 



This parameter is optional, in use with paymentInfo details.


 
object
This field is optional, but must be set if paymentMethod = kco, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = sms, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = creditcardPayex, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = swishPayex, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = vippsEcommerce, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = nexi, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = other, otherwise the request will fail.


 
mcPayRef
string
McPay transaction id. Specify it if the order was prepaid using McPay.


 
shareCode
string  <= 255 characters 
Share code, the unique key to find given share. When provided order will be treated as B2B order for accepted shared subscription.


 
Responses 
200
OK


Response Schema: application/json
orderId
integer
OrderId for created order.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/client/order
Request samples 
application/json
A self-pay customer is a customer who are payer and receiver. Only payer is required and receiver is not relevant here. 


{
  • "externalOrderId": "23456",
  • "orderDate": 1547078400000,
  • "paymentMethod": "creditcardPayex",
  • "orderAmount": 150,
  • "currency": "NOK",
  • "marketingCouponCode": "NOA3263",
  • "marketingCouponNumber": 51,
  • "campaignParameters": "?param=Datanews&param2=Dataold",
  • "companyCode": "468979834",
  • "seller": "AY",
  • "salesMethod": "ST",
  • "payer": {
    },
  • "orderLines": [
    ],
  • "recurring": true,
  • "paymentInfoPayEx": {
    }
}
Response samples 
application/json
{
  • "orderId": 9
}
Register order
The user needs to be logged in to use this endpoint, click here to read more.


API for creating an order. The order can contain one or more lines. Each line may contain a receiver. If Marketing coupon is used both marketing coupon, i.e marketingCouponCode and marketingCouponNumber, fields are required. 


There are several possible payment methods. Payment provider configuration is needed to use these payment methods, excluding free and invoice. In order to set up this configuration, please contact Mediaconnect by sending an email to Support at Mediaconnect. Some of the payment providers support recurring payment and prepayment, see the table below.



  

    paymentMethod
     recurring=true
    recurring=false
    prepaid=true
    prepaid=false
  

  

    invoice
    ✔
    ✔
    
    ✔
  

  

    sms (Link Mobility)
    ✔
    
    
    ✔
  

  

    smsPay
    
    ✔
    ✔
    
  

  

    vippsRecurring 
(Faste betalinger med Vipps)		
    ✔
    
    
    ✔
  

  

    kco (Klarna)
    ✔
    ✔
    ✔
    ✔
  

  

    creditcardPayex
    ✔
    ✔
    ✔
    ✔
  

  

    swishPayex
    
    ✔
    ✔
    ✔
  

  

    vippsEcommerce 
 (single payment)		
    
    ✔
    ✔
    ✔
  

  

    nexi
    ✔
    ✔
    ✔
    ✔
  

  

    other
    
    ✔
    ✔
    
  





Commonly required fields:


    

  • companyName or lastName
    • 

  • postalCode
    • 

  • emails or phoneNumbers
    • 



After placing an order to the client order API, the order needs to be fulfilled. This can be done either with a redirect or using an API call.
The specific use-case dictates whether how the fulfillment process can be performed. If the fulfillment includes an interactive payment process (e.g. card payment), the redirect must be used. If the order is prepaid, or does not involve the user for payment (e.g. invoice), the API for fulfillment may be used.


For the redirect case, the user must be redirected to the URL for fulfillment (https://connectid.no/user/fulfillment or https://connectid.se/user/fulfillment). Depending on the payment method on the order the user will be further redirected to an external payment service.
Read more about fulfillment URL.


The API endpoint for fulfillment is described here.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
externalOrderId
string  <= 40 characters 
Order ID from the system delivering the order.


 
orderDate
required
integer
The date the order was placed in the external system.


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


 
paymentMethod
required
string
It is only allow to use these payment methods:


    

  • invoice: Paying by sending a invoice
    • 

  • free:  It is free of cost.
    • 

  • sms: Paying by using SMS via Link Mobility.
    • 

  • smsPay: Paying by using SMS via SMSpay.
    • 

  • masterpass: Paying by using a digital wallet provided by Mastercard.
    • 

  • vippsRecurring: Paying by using Vipps (Faste betalinger med Vipps).
    • 

  • kco: Paying by using Klarna Checkout.
    • 

  • creditcardPayex: Paying by using a credit card via Payex.
    • 

  • swishPayex: Paying by using Swish via Payex.
    • 

  • vippsEcommerce: Paying by using Vipps Ecommerce (single payment).
    • 

  • nexi: Paying by using Nexi.
    • 

  • other: Paying by using own integration with payment provider.
    • 



 Enum: "invoice" "free" "sms" "smsPay" "masterpass" "vippsRecurring" "kco" "creditcardPayex" "swishPayex" "vippsEcommerce" "nexi" "other"  
merchantId
string  <= 64 characters 
Unique ID that identify the payment provider.


 
orderAmount
required
number  decimal places <= 2 
Total amount for the entire order.


 
currency
required
string  <= 3 characters 
Currency for the entire order has to follow  the standard ISO4217 - alphabetic code.


 
marketingCouponCode
string  <= 12 characters 
Marketing coupon code to use in a e.g product order.


 
marketingCouponNumber
integer
Marketing coupon number to use in a e.g product order.


 
campaignParameters
string  <= 64 characters 
Field is related to lookup of market coupons. The value is a URL query param which points to a sales place.


 
companyCode
string  <= 12 characters 
Company code for the products in the order. Company code is used to find correct merchant etc for billing and such. If it is null client’s company code is used.


 
customerReference
string  <= 78 characters 
Customer reference number.


 
seller
string  <= 12 characters 
Seller code representing the salesperson who made this order come true.


 
salesMethod
string  <= 12 characters 
Method of sale


 
required
object (Name and address for payer) 
 
required
Array of objects
 
recurring
boolean
 Default:  true
It informs if recurring payment should be done on this order.


    

  • true: The recurring payment will be enabled if the payment provider support this and coupon/product allow to do the recurring payment.
    • 

  • false: The recurring payment will not be enabled. For one-time purchase needs to be false.
    • 



 
prepaid
boolean
 Default:  false
It informs if the order is prepaid.


    

  • true:  The order was prepaid. There is no need to do the payment.
    • 

  • false: The order is not prepaid.
    • 



This parameter is optional, in use with paymentInfo details.


 
object
This field is optional, but must be set if paymentMethod = kco, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = sms, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = creditcardPayex, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = swishPayex, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = vippsEcommerce, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true and paymentMethod = nexi, otherwise the request will fail.


 
object
This field is optional, but must be set if prepaid= true  and paymentMethod = other, otherwise the request will fail.


 
mcPayRef
string
McPay transaction id. Specify it if the order was prepaid using McPay.


 
shareCode
string  <= 255 characters 
Share code, the unique key to find given share. When provided order will be treated as B2B order for accepted shared subscription.


 
Responses 
200
OK


Response Schema: application/json
orderId
integer
OrderId for created order.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/order
Request samples 
application/json
A self-pay customer is a customer who are payer and receiver. Only payer is required and receiver is not relevant here. 


{
  • "externalOrderId": "23456",
  • "orderDate": 1547078400000,
  • "paymentMethod": "creditcardPayex",
  • "orderAmount": 150,
  • "currency": "NOK",
  • "marketingCouponCode": "NOA3263",
  • "marketingCouponNumber": 51,
  • "campaignParameters": "?param=Datanews&param2=Dataold",
  • "companyCode": "468979834",
  • "seller": "AY",
  • "salesMethod": "ST",
  • "payer": {
    },
  • "orderLines": [
    ],
  • "recurring": true,
  • "paymentInfoPayEx": {
    }
}
Response samples 
application/json
{
  • "orderId": 9
}
➔ Next to Reward