MediaConnect AS
Powered by Redocly

Customer

List customer info

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

Customer API for customer details.

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
customerNumber
integer

Customer number in the partner datastore

object (Name)
Array of objects (Phone Number)
emails
Array of strings <email>

Email address (each email maximum 255 character)

invoiceEmailAddress
string <email> <= 60 characters

Email address that shall be used for sending email invoice

Array of objects

List of user ids connected to customer number

400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/info
Request samples 
Response samples 
application/json
{
  • "customerNumber": 563457,
  • "name": {
    },
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "invoiceEmailAddress": "ola.nordmann@hotmail.no",
  • "attachedUsers": {
    }
}
Change customer Info
The user needs to be logged in to use this endpoint, click here to read more.


This API updates customer data and will replace the existing customerdata for every field in the request. This means fields that are not specified are defined as null in the request. Name in Connect required minimum lastName or companyName. If request is null or empty, then lastName will be set to “-”. In this API we may set an email  address that shall be used for sending email invoice.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
object (Name) 
 
Array of objects (Phone Number) 
 
emails
Array of strings <email> 
Email address (each email maximum 255 character)


 
invoiceEmailAddress
string <email>   <= 60 characters 
Email address that shall be used for sending email invoice


 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was created.
    • 

  • false The external reference was not created.
    • 



 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/customer/info
Request samples 
application/json
{
  • "name": {
    },
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "invoiceEmailAddress": "ola.nordmann@hotmail.no"
}
Response samples 
application/json
{
  • "success": true
}
Search 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.


This API allows to retrieve information about one or more customers.


Search results may be one or more customers, depending on the arguments used and what is actually present in the database.


In combination with customer number and name, you can also fill in the product. This will "shrink" search result.


Requirements for fields:


Searching by name or address require following fields to be set in request:


    

  • companyName or lastName
    • 

  • streetAddress
    • 

  • postalCode or postalPlace
    • 



Otherwise one of following fields to be set in request:


    

  • phoneNumber  
    • 

  • email
    • 



Response


The response is a list of customers found. The list is empty if no customer is found.


Number of customers in response are limited to 5 customers.


SecurityClient_Credentials 
Request 
Request Body schema: application/json
productCode
string  <= 12 characters 
Product code to match in search.


 
companyName
string  <= 40 characters 
Company name to match in a name/address search.


 
departmentName
string  <= 40 characters 
Department name to match in a name/address search.


 
firstName
string  <= 30 characters 
First name to match in a name/address search.


 
middleName
string  <= 30 characters 
Middle name to match in a name/address search.


 
lastName
string  <= 30 characters 
Last name to match in a name/address search.


 
careOfAddress
string  <= 40 characters 
Care of address to match in a name/address search.


 
streetAddress
string  <= 40 characters 
Street name to match in a name/address search.


 
streetNumber
integer
Street number to match in a name/address search.


 
entrance
string  <= 12 characters 
Entrance to match in a name/address search.


 
postalCode
string  <= 10 characters 
Postal code to match in a name/address search.


 
postalPlace
string  <= 30 characters 
Postal place to match in a name/address search.


 
countryCode
string  <= 3 characters 
Country code, in ISO 3166-2 format, to match in a search.    


 
phoneNumber
string  <= 20 characters 
Phone number to match in a search.


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


 
email
string <email>   <= 255 characters 
Email to match in a search.


 
Responses 
200
OK


Response Schema: application/json
Array of objects  <= 5 items 
 
400
Bad Request


403
Forbidden - Number of customers in response are limited to 5 customers


429
Too Many Requests


500
Internal Server Error


post/v1/client/customer/search
Request samples 
application/json
{
  • "productCode": "CO27409",
  • "companyName": "Company International Ltd",
  • "departmentName": "Support",
  • "firstName": "Ola",
  • "middleName": "Fjordstrand",
  • "lastName": "Nordmann",
  • "careOfAddress": "",
  • "streetAddress": "Grubbegata",
  • "streetNumber": 6,
  • "entrance": "A",
  • "postalCode": 179,
  • "postalPlace": "Oslo",
  • "countryCode": "NO",
  • "phoneNumber": "+4712345678",
  • "email": "ola.nordmann@company.com"
}
Response samples 
application/json
{
  • "customers": [
    ]
}
Check customer number - 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.


This API will return a list with customers from input with credentials.


SecurityClient_Credentials 
Request 
Request Body schema: application/json
credentials
required
Array of strings
List of credentials to check


 
Responses 
200
OK


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


429
Too Many Requests


500
Internal Server Error


post/v1/client/credential/customers/check
Request samples 
application/json
{
  • "credentials": [
    ]
}
Response samples 
application/json
{
  • "customers": [
    ]
}
List customer info - 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.


SecurityClient_Credentials 
Request 
path Parameters
customerNumber
required
integer
Customer number


 
Responses 
200
OK


Response Schema: application/json
customerNumber
integer
Customer number in the partner datastore


 
object (Name) 
 
Array of objects (Phone Number) 
 
emails
Array of strings <email> 
Email address (each email maximum 255 character)


 
invoiceEmailAddress
string <email>   <= 60 characters 
Email address that shall be used for sending email invoice


 
Array of objects
List of user ids connected to customer number


 
400
Bad Request


404
Not Found


429
Too Many Requests


500
Internal Server Error


get/v1/client/customer/info/{customerNumber}
Request samples 
Response samples 
application/json
{
  • "customerNumber": 563457,
  • "name": {
    },
  • "phoneNumbers": [
    ],
  • "emails": [
    ],
  • "invoiceEmailAddress": "ola.nordmann@hotmail.no",
  • "attachedUsers": {
    }
}
➔ Next to External Reference