Register order - client mode

Production

https://api.mediaconnect.no/capi

POST

/v1/client/order

Order

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 Unite by sending an email to support@mediaconnect.no. 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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/order' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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": {
        "customerNumber": 71,
        "personsSocialSecurityNumber": "890102-3286",
        "firstName": "Kari",
        "middleName": "Snøhaug",
        "lastName": "Nordmann",
        "street": "Osloveien",
        "streetNumber": 12,
        "floorType": "H",
        "floor": 3,
        "postalCode": "0101",
        "postalPlace": "Oslo",
        "postalAddress": "Postboks 6",
        "postalAddressPostalCode": "0216",
        "postalAddressPostalPlace": "Oslo",
        "countryCode": "NO",
        "birthDate": 694224000000,
        "sex": "female",
        "emails": [
            "kari.nordmann@gmail.com"
        ],
        "phoneNumbers": [
            "+4787654321"
        ],
        "invoiceEmailAddress": "kari@company.com"
    },
    "orderLines": [
        {
            "productSpecType": "coupon",
            "productSpecCode": "VS283",
            "productSpecNo": 1673,
            "quantity": 1,
            "unitPrice": 150,
            "voucherCode": "582358",
            "allowAccessProduct": "29452",
            "allowAccessCategoryType": "TYPE1",
            "allowAccessSeconds": 259200,
            "startInfo": {
                "startDate": 1547078400000,
                "startIssue": "2019-10"
            }
        }
    ],
    "recurring": true,
    "paymentInfoPayEx": {
        "transactionId": "472",
        "merchantId": "54823419",
        "recurrenceToken": "7b9nwomhbok",
        "cardDetails": {
            "cardMaskedPan": "****-******-8271",
            "expMonth": "10",
            "expYear": "24",
            "issuingBank": "Mastercard",
            "cardBrand": "Mastercard",
            "isPanEnrolled": true
        }
    }
}'

Response Example

200 - Success

{
    "orderId": 9
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

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

Example:

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

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

externalOrderId

string

optional

Order ID from the system delivering the order.

<= 40 characters

orderDate

integer

required

The date the order was placed in the external system.

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

paymentMethod

enum<string>

required

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.

Allowed values:

invoicefreesmssmsPaymasterpassvippsRecurringkcocreditcardPayexswishPayexvippsEcommercenexiother

merchantId

string

optional

Unique ID that identify the payment provider.

<= 64 characters

orderAmount

number

required

Total amount for the entire order.

Multiple of:

0.01

currency

string

required

Currency for the entire order has to follow the standard ISO4217 - alphabetic code.

<= 3 characters

marketingCouponCode

string

optional

Marketing coupon code to use in a e.g product order.

<= 12 characters

marketingCouponNumber

integer

optional

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

campaignParameters

string

optional

Field is related to lookup of market coupons. The value is a URL query param which points to a sales place.

<= 64 characters

companyCode

string

optional

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.

<= 12 characters

customerReference

string

optional

Customer reference number.

<= 78 characters

uniqueUserId

string

required

Unique ID (from Profile API)

seller

string

optional

Seller code representing the salesperson who made this order come true.

<= 12 characters

salesMethod

string

optional

Method of sale

<= 12 characters

payer

object (Name and address for payer)

required

customerNumber

integer

optional

A valid and existing customer number in the Connect environment

companyRegistrationNumber

string

optional

A valid registration number in an official registry.

<= 16 characters

companyName

string

optional

Name of the company.

<= 40 characters

department

string

deprecated

Name of the department. Use the departmentName field instead of this.

<= 40 characters

departmentName

string

optional

Name of the department.

<= 40 characters

personsSocialSecurityNumber

string

optional

A valid personal social security number.

<= 16 characters

firstName

string

optional

First (given) name.

<= 30 characters

middleName

string

optional

Middle name.

<= 30 characters

lastName

string

optional

Last (family) name.

<= 30 characters

coAddress

string

deprecated

Extra address line if needed. Use the careOfAddress field instead of this.

<= 40 characters

careOfAddress

string

optional

Extra address line if needed.

<= 40 characters

street

string

optional

Street address

<= 40 characters

streetNumber

integer

optional

Street number

entrance

string

optional

Entrance

<= 12 characters

floorType

string

optional

Valid values:

H: Main floor

U: Lower floor

L: Attic

K: Basement

<= 1 characters

floor

integer

optional

Floor.

suite

string

optional

Suite

<= 10 characters

postalCode

string

optional

A valid postal code for the street address.

<= 10 characters

postalPlace

string

optional

Postal place

<= 30 characters

postalAddress

string

optional

Postal address

<= 40 characters

postalAddressPostalCode

string

optional

A valid postal code for the postal address

<= 10 characters

postalAddressPostalPlace

string

optional

Postal place for the postal address.

<= 30 characters

countryCode

string

optional

The country code for this address - ISO 3166 - alpha-2

<= 3 characters

birthDate

integer

optional

Birth date if this is a person.

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

sex

enum<string>

optional

Valid values

male: The person is a male.

female: The person is a female.

unknown: The gender is unknown.

Allowed values:

malefemaleunknown

emails

array[string <email>]

optional

A list of email addresses beloning to the person or company. 0, 1 or 2 addresses (each address maximum 255 characters)

>= 0 items<= 2 items

phoneNumbers

array[string]

optional

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

<= 4 items

invoiceEmailAddress

string

optional

This email will be set for invoices for products that comes in order.

<= 255 characters

Responses

🟢200OK

application/json

Body

orderId

integer

optional

OrderId for created order.

🟠400Bad Request

🟠429429

🔴500Server Error