Use this service to create users, manage their properties including shipping addresses, phone numbers, email addresses and other preferences. Also manage relations between users and assign permissions as needed.

Feel free to check the ChangeLog for additional information and latest updates to the service

  • GetCustomer

    This method allows to get full info about the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    Parameter Mandatory Type Description
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string County ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    CellNumber No string User's cell phone number
    CustomerNumber No string ID of the user
    DateOfBirth No dateTime User's date of birth
    EmailAddress No string User's email
    FirstName No string User's first name
    LastName No string User's last name
    PersonalNumber No string User's personal number
    PhoneNumber No string User's phone number
    ProfileImage No base64Binary User's profile image
    ProfileImageSize No long User's profile image size
    RegistrationDate No dateTime User's registration date
    Gender No dateTime User's registration date
    Industry No dateTime User's registration date
    Interests No dateTime User's registration date
    MaritalStatus No dateTime User's registration date
    SignificantOther No dateTime User's registration date
    Skills No dateTime User's registration date

    Examples

    Request

    Response

    {
      {
      "d": {
        "__type": "Customer.CustomerData:WebServices",
        "AddressLine1": null,
        "AddressLine2": null,
        "City": null,
        "CountryIso": null,
        "PostalCode": null,
        "StateIso": null,
        "AboutMe": "A short text telling us about you",
        "CellNumber": null,
        "CustomerNumber": "6816476",
        "DateOfBirth": null,
        "Education": "",
        "EmailAddress": "demo@coriunder.com",
        "FirstName": "John",
        "Gender": "Male",
        "Industry": null,
        "Interests": [],
        "LastName": " Doe",
        "MaritalStatus": "Single",
        "PersonalNumber": null,
        "PhoneNumber": null,
        "ProfileImage": null,
        "ProfileImageSize": 0,
        "RegistrationDate": "/Date(1487669072000+0000)/",
        "SignificantOther": null,
        "Skills": [
          {  
            "Key": 1,
            "Value": "Algorithms"
          },
          {    
            "Key": 2,
            "Value": "Analytics"
          },
          { 
            "Key": 7,
            "Value": "Business Analysis"
          }
        ]
      }
    }
    }
  • RegisterCustomer

    This method allows to register a new user in the system. It also automatically checks whether provided email was registered earlier to avoid creating accounts with similar emails.

    Request - Filters

    Parameter Mandatory Type Description
    data No This block contains registration data
    ApplicationToken No string Set your application token here
    Password No string User's password
    PinCode No string User's PIN code
    ShippingAddresses No Array Contains objects with user's shipping addresses' data. Check such object's structure below.
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Comment No string Comment to the shipping address
    IsDefault No boolean Define whether this shipping address is default. Only one default shipping address per user's account can exist. In case the user already has a default shipping address and tries to set another shipping address as default, the shipping address marked as default earlier will be set to non-default automatically by the system.
    Title No string Shipping address's title
    StoredPaymentMethods No Array Contains objects with user's payment methods' data. Check such object's structure below.
    AccountValue1 No string Account number of the payment method (e.g. card number)
    AccountValue2 No string In cases where the account requires more then one field the account value 2 will be used to store that info ( like routing number )
    BillingAddress No This block contains info about payment method's billing address
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Display No string Payment method's display name
    ExpirationDate No dateTime Payment method's expiration date
    ID No int No need for ID here, all addresses will be new at this step
    Icon No string Icon for the payment method
    IsDefault No boolean Define whether this payment method is default. Only one default payment method per user's account can exist. In case the user already has a default payment method and tries to set another payment method as default, the payment method marked as default earlier will be set to non-default automatically by the system.
    IssuerCountryIsoCode No string The country where the payment method was issued.
    Last4Digits No string Last 4 digits of the payment methods' number
    OwnerName No string Payment method's owner name
    PaymentMethodGroupKey No string ID of the group which the payment method should belong to
    PaymentMethodKey No string ID of the type which the payment method should belong to
    Title No string Payment method's title
    info No This block contains main user's info
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    CellNumber No string User's cell phone number
    CustomerNumber No string ID of the user
    DateOfBirth No dateTime User's date of birth
    EmailAddress No string User's email
    FirstName No string User's first name
    LastName No string User's last name
    PersonalNumber No string User's personal number
    PhoneNumber No string User's phone number
    ProfileImage No base64Binary User's profile image
    ProfileImageSize No long User's profile image size
    RegistrationDate No dateTime User's registration date
    AboutMe No string Use this field to save a short BIO about the user, you can save up to 5000 characters
    Gender No string The Gender of the registered user (send: Male/Female)
    Industry No string The industry the user belongs to, a more general approach then SetPosition which includes all of the Job history for the user.
    Education No string A short description of the educational level of the user.
    MaritalStatus No string Save the Marital Status of the user ( Married/Single/Divorced)
    SignificantOther No string Save a customer number for the user's Significant Other
    Interests No ArrayOfstring Save the user's interests by lising them, comma separated.
    Skills No ArrayOfstring Use the International service to get the full list of Skills available, you can add additional Skills by sending them as part of the request.

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "data": {
        "ApplicationToken": "string",
        "Password": "string",
        "PinCode": "string",
        "ShippingAddresses": [
          {
            "AddressLine1": "string",
            "AddressLine2": "string",
            "City": "string",
            "CountryIso": "string",
            "PostalCode": "string",
            "StateIso": "string",
            "Comment": "string",
            "ID": int,
            "IsDefault": boolean,
            "Title": "string"
          },
          ...
        ],
        "StoredPaymentMethods": [
          {
            "AccountValue1": "string",
            "AccountValue2": "string",
            "BillingAddress": {
              "AddressLine1": "string",
              "AddressLine2": "string",
              "City": "string",
              "CountryIso": "string",
              "PostalCode": "string",
              "StateIso": "string"
            },
            "Display": "string",
            "ExpirationDate": dateTime,
            "ID": int,
            "Icon": "string",
            "IsDefault": boolean,
            "IssuerCountryIsoCode": "string",
            "Last4Digits": "string",
            "OwnerName": "string",
            "PaymentMethodGroupKey": "string",
            "PaymentMethodKey": "string",
            "Title": "string"
          },
          ...
        ],
        "info": {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string",
          "CellNumber": "string",
          "CustomerNumber": "string",
          "DateOfBirth": dateTime,
          "EmailAddress": "string",
          "FirstName": "string",
          "LastName": "string",
          "PersonalNumber": "string",
          "PhoneNumber": "string",
          "ProfileImage": base64Binary,
          "ProfileImageSize": long,
          "RegistrationDate": dateTime,
          "Gender": "Male",
          "Industry": null,
          "Education": null,
          "MaritalStatus": null,
          "SignificantOther": null,
          "Interests": [],
          "Skills": [],
        }
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • SaveCustomer

    This method allows to update info about the currently logged in user.

    Request - Filters

    Parameter Mandatory Type Description
    info No This block should contain info about the user
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    CellNumber No string User's cell phone number
    CustomerNumber No string ID of the user
    DateOfBirth No dateTime User's date of birth
    EmailAddress No string User's email
    FirstName No string User's first name
    LastName No string User's last name
    PersonalNumber No string User's personal number
    PhoneNumber No string User's phone number
    ProfileImage No base64Binary User's profile image
    ProfileImageSize No long User's profile image size
    RegistrationDate No dateTime User's registration date

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "info": {
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "CountryIso": "string",
        "PostalCode": "string",
        "StateIso": "string",
        "CellNumber": "string",
        "CustomerNumber": "string",
        "DateOfBirth": dateTime,
        "EmailAddress": "string",
        "FirstName": "string",
        "LastName": "string",
        "PersonalNumber": "string",
        "PhoneNumber": "string",
        "ProfileImage": base64Binary,
        "ProfileImageSize": long,
        "RegistrationDate": dateTime
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • FindFriend

    This method allows to search for other users by their names or IDs.
    It returns results by pages and assumes that all pages have similar size. For example, in case you'll set page 2 with page size 20, you'll receive items at positions from 20 to 40, but in case you'll set page 2 with page size 5, you'll receive items at positions from 5 to 10, not depending on what results you received before.

    Request - Filters

    Parameter Mandatory Type Description
    searchTerm No string ID or name of the user to search for
    sortAndPage No This block contains sort and page filters
    PageNumber No int Set page number here. Minimum value is 1
    PageSize No int Set amount of items per page here

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    Items Array Contains objects with found users' data. Check such object's structure below.
    DestWalletId string ID of the found user
    FullName string Name of the found user
    ProfileImage base64Binary Profile picture of the found user
    ProfileImageSize long Size of the user's profile picture
    RelationType int Relation type between this user and currently logged in user

    Examples

    Request

    {
      "searchTerm": "string",
      "sortAndPage": {
        "PageNumber": int,
        "PageSize": int
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "Items": [
          {
            "DestWalletId": "string",
            "FullName": "string",
            "ProfileImage": base64Binary,
            "ProfileImageSize": long,
            "RelationType": int
          },
          ...
        ]
      }
    }
  • FriendRequest

    This method allows to send friend request from the currently logged in user to another user.

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string ID of the user to which the friend request should be sent

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    Items Array Contains object with data about the user to which the request has been sent. Check such object's structure below.
    DestWalletId string ID of the user to which the request has been sent
    FullName string Name of the user to which the request has been sent
    ProfileImage base64Binary Profile picture of the user to which the request has been sent
    ProfileImageSize long Size of the user's profile picture
    RelationType int Relation type between this user and currently logged in user

    Examples

    Request

    {
      "destWalletId": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "Items": [
          {
            "DestWalletId": "string",
            "FullName": "string",
            "ProfileImage": base64Binary,
            "ProfileImageSize": long,
            "RelationType": int
          },
          ...
        ]
      }
    }
  • GetFriendRequests

    This method allows to get all incoming friend requests (or incoming friend request from exact user) for the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string In case only exact user's friend request has to be loaded, set required user's ID here.
    In case all friend requests to the currently logged in user have to be loaded, set an empty string for this parameter

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    Items Array Contains objects with data about users which have sent friend requests to the currently logged in user. Check such object's structure below.
    DestWalletId string ID of the user who has sent the request
    FullName string Name of the user who has sent the request
    ProfileImage base64Binary Profile picture of the user who has sent the request
    ProfileImageSize long Size of the user's profile picture
    RelationType int Relation type between this user and currently logged in user

    Examples

    Request

    {
      "destWalletId": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "Items": [
          {
            "DestWalletId": "string",
            "FullName": "string",
            "ProfileImage": base64Binary,
            "ProfileImageSize": long,
            "RelationType": int
          },
          ...
        ]
      }
    }
  • GetFriends

    This method allows to get a list with info about all friends (or exact friend) of the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string In case only exact user's info has to be requested, set required user ID here.
    In case all currently logged in user's friends info has to be requested, set an empty string for this parameter

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    Items Array Contains objects with user's friends' data. Check such object's structure below.
    DestWalletId string ID of the user's friend
    FullName string Name of the user's friend
    ProfileImage base64Binary Profile picture of the user's friend
    ProfileImageSize long Size of the friend's profile picture
    RelationType int Relation type between this friend and currently logged in user

    Examples

    Request

    {
      "destWalletId": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "Items": [
          {
            "DestWalletId": "string",
            "FullName": "string",
            "ProfileImage": base64Binary,
            "ProfileImageSize": long,
            "RelationType": int
          },
          ...
        ]
      }
    }
  • ImportFriendsFromFacebook

    This method allows to import currently logged in user's Facebook friends in case they are registered in the system

    Request - Filters

    Parameter Mandatory Type Description
    accessToken No string Facebook access token for the currently logged in user's facebook account. Needs to be obtained on the client's side and include "email" and "user_friends" permission. Gives the system ability to check user's Facebook friends and import them to the system

    Response - Parameters

    Parameter Type Description
    This method is void and has an empty response body

    Examples

    Request

    {
      "accessToken": "string"
    }

    Response

    {
      "d": null
    }
  • RemoveFriend

    This method allows to remove exact user from the currently logged in user's friend list.

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string ID of the user which has to be removed from the currently logged in user's friend list

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "destWalletId": "string"
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • ReplyFriendRequest

    This method allows to approve or decline friend request from exact user.

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string ID of the user whose friend request should be approved or declined
    approve No boolean Define whether request should be approved (true) or declined (false)

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "destWalletId": "string",
      "approve": boolean
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • SetFriendRelation

    System allows to sort user's friends by relations (family, friend, etc). This method gives ability to set relation for a friend.

    Request - Filters

    Parameter Mandatory Type Description
    destWalletId No string ID of the user (friend) with which relation should be set
    relationTypeKey No int ID of the relation which has to be set (as provided in the international webservice

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "destWalletId": "string",
      "relationTypeKey": int
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • GetPositions

    This method allows to get full info about the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    Parameter Type Description
    ID int This will return the IDs of the positions available for the Customer

    Examples

    Request

    Response

    {
      "d": {
        [1,3,6]
      }
    }
  • GetPosition

    This method allows to get full info about the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    Parameter Type Description
    ID int This will return the IDs of the positions available for the Customer

    Examples

    Request

    Response

    {
      "d": {
        [1,3,6]
      }
    }
  • SetPosition

    This method allows to get full info about the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    Title int This will return the IDs of the positions available for the Customer
    Summary int This will return the IDs of the positions available for the Customer
    IsCurrent int This will return the IDs of the positions available for the Customer
    Company int This will return the IDs of the positions available for the Customer
    CompanySite int This will return the IDs of the positions available for the Customer
    StartDate int This will return the IDs of the positions available for the Customer
    EndDate int This will return the IDs of the positions available for the Customer
    Industry int This will return the IDs of the positions available for the Customer

    Response - Parameters

    Parameter Type Description
    ID int This will return the IDs of the positions available for the Customer

    Examples

    Request

    
            {
                "data":{
                    "Title":"Test",
                    "Summary":"Test",
                    "IsCurrent":"false",
                    "Company":"Test",
                    "CompanySite":"Test",
                    "StartDate":"/Date(1488102159550+0200)/",
                    "EndDate":"/Date(1488102159550+0200)/",
                    {"Industry":{"ID":"3"}}
                    }
            }

    Response

    {
      "d": {
        [1]
      }
    }
  • GetImage

    This method allows to get profile picture of any user in the system (currently logged in user, his friends, etc).

    Request - Filters

    Parameter Mandatory Type Description
    walletId No string ID of the customer (friend) whose profile picture has to be downloaded<
    asRaw No boolean Defines whether the image has to be downloaded as raw data or not

    Response - Parameters

    Type Description
    base64Binary Downloaded image itself

    Examples

    Request

    {
      "walletId": "string",
      "asRaw": boolean
    }

    Response

    
        
  • DeleteShippingAddress

    This service call allows to delete current user's shipping address which was stored earlier

    Request - Filters

    Parameter Mandatory Type Description
    addressId No int ID of the shipping address which has to be deleted

    Response - Parameters

    Parameter Type Description
    d (root element) boolean Defines whether shipping address was deleted successfully

    Examples

    Request

    {
      "addressId": int
    }

    Response

    {
      "d": boolean
    }
  • GetShippingAddress

    This service call allows to get current user's exact shipping address' data

    Request - Filters

    Parameter Mandatory Type Description
    addressId No int ID of the shipping address which data has to be loaded

    Response - Parameters

    Parameter Mandatory Type Description
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Comment No string Comment to the shipping address
    ID No int ID of the shipping address
    IsDefault No boolean Defines whether this shipping address is marked as default
    Title No string Shipping address' title

    Examples

    Request

    {
      "addressId": int
    }

    Response

    {
      "d": {
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "CountryIso": "string",
        "PostalCode": "string",
        "StateIso": "string",
        "Comment": "string",
        "ID": int,
        "IsDefault": boolean,
        "Title": "string"
      }
    }
  • GetShippingAddresses

    This method allows to get all shipping addresses for the currently logged in user.

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects shipping addresses for which user have to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    As a response this method returns an array which contains objects with info about currently logged in user's shipping addresses. Each object includes parameters represented in the table below.

    Parameter Mandatory Type Description
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Comment No string Comment to the shipping address
    ID No int ID of the shipping address
    IsDefault No boolean Defines whether this shipping address is marked as default
    Title No string Shipping address's title

    Examples

    Request

    
        

    Response

    {
      "d": [
        {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string",
          "Comment": "string",
          "ID": int,
          "IsDefault": boolean,
          "Title": "string"
        },
        ...
      ]
    }
  • SaveShippingAddress

    This service call allows to create new or update existing shipping address for the currently logged in user.

    Request - Filters

    Parameter Mandatory Type Description
    address No This block contains info about the shipping address which has to be saved
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Comment No string Comment to the shipping address
    ID No int In case an existing shipping address has to be updated, put ID of that shipping address here
    In case a new shipping address has to be added, set value 0 for this parameter
    IsDefault No boolean Define whether this shipping address is default. Only one default shipping address per user's account can exist. In case the user already has a default shipping address and tries to set another shipping address as default, the shipping address marked as default earlier will be set to non-default automatically by the system.
    Title No string Shipping address's title

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    RecordNumber int *TBD*
    RefNumbers ArrayOfstring *TBD*

    Examples

    Request

    {
      "address": {
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "CountryIso": "string",
        "PostalCode": "string",
        "StateIso": "string",
        "Comment": "string",
        "ID": int,
        "IsDefault": boolean,
        "Title": "string"
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "RecordNumber": int,
        "RefNumbers": [ArrayOfstring]
      }
    }
  • SaveShippingAddresses

    This service call allows to create new or update existing shipping addresses (several at once) for the currently logged in user.

    Request - Filters

    Parameter Mandatory Type Description
    data No Array Should contain objects with shipping addresses' data. Check such object's structure below.
    AddressLine1 No string Primary address
    AddressLine2 No string Secondary address
    City No string City
    CountryIso No string Country ISO
    PostalCode No string Postal code
    StateIso No string State ISO
    Comment No string Comment to the shipping address
    ID No int In case an existing shipping address has to be updated, put ID of that shipping address here
    In case a new shipping address has to be added, set value 0 for this parameter
    IsDefault No boolean Define whether this shipping address is default. Only one default shipping address per user's account can exist. In case the user already has a default shipping address and tries to set another shipping address as default, the shipping address marked as default earlier will be set to non-default automatically by the system.
    Title No string Shipping address's title

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    RecordNumber int *TBD*
    RefNumbers ArrayOfstring *TBD*

    Examples

    Request

    {
      "data": [
        {
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "CountryIso": "string",
          "PostalCode": "string",
          "StateIso": "string",
          "Comment": "string",
          "ID": int,
          "IsDefault": boolean,
          "Title": "string"
        },
        ...
      ]
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "RecordNumber": int,
        "RefNumbers": [ArrayOfstring]
      }
    }
  • RegisterCustomerAsSubAccount

    This method allows to register a new user in the system which will be defined as a subuser for the already registered user. The subuser will be as any other user in the system but will connected to the main account with a relation type. The subaccount registration process is shorter but the ability to add additional info to the subaccount is available using the "SaveCustomer" service.It also automatically checks whether provided email was registered earlier to avoid creating accounts with similar emails.

    Request - Filters

    Parameter Mandatory Type Description
    data No This block contains registration data
    ApplicationToken No string Set your application token here
    Password No string User's password
    PinCode No string User's PIN code
    CellNumber No string User's cell phone number
    EmailAddress No string User's email
    FirstName No string User's first name
    LastName No string User's last name
    PersonalNumber No string User's personal number
    PhoneNumber No string User's phone number

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message

    Examples

    Request

    {
      "data": {
        "ApplicationToken": "string",
        "Password": "string",
        "PinCode": "string",
        "info": {
          "CellNumber": "string",
          "EmailAddress": "string",
          "FirstName": "string",
          "LastName": "string",
          "PersonalNumber": "string",
          "PhoneNumber": "string",
        }
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string"
      }
    }
  • GetManagedAccounts

    This method allows to get the list of all sub accounts for the currently logged in user

    Request - Filters

    Parameter Mandatory Type Description
    This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

    Response - Parameters

    Parameter Mandatory Type Description
    CustomerNumber No string ID of the user
    CustomerName No string User's full name

    Examples

    Request

    Response

    {
      {
      "d": {
        "__type": "Customer.CustomerData:WebServices",
        {
        "CustomerNumber": "6816476",
        "FullName": "John Doe"
        },
        {
        "CustomerNumber": "6816987",
        "FullName": "John Noe"
        },
        {
        "CustomerNumber": "6816857",
        "FullName": "John Loee"
        } 
      }
    }
    }
  • GetChildCredentials

    This method allows already existing users to log into the system.

    Request - Filters

    Parameter Mandatory Type Description
    childCustomerNumber Yes string Customer ID of the sub account you wish to login on his behalf

    Response - Parameters

    Parameter Type Description
    Code int Result code
    IsSuccess boolean Defines whether service call was processed successfully or not
    Key string Result key ("Success", "Error", etc.)
    Message string Result message
    CredentialsHeaderName string Name of the header which should hold credentials token. Check headers' topic to get more info
    CredentialsToken string User's credentials token, which should be also added to headers. Check headers' topic to get more info
    EncodedCookie string *TBD*
    IsDeviceActivated boolean Defines whether devices was activated using DeviceActivate method
    IsDeviceBlocked boolean Defines whether device was blocked by the system
    IsDeviceRegistered boolean Defines whether devices was registered using RegisterDevice method
    IsDeviceRegistrationRequired boolean Defines whether registering device with RegisterDevice method is required
    IsFirstLogin boolean Defines whether this is first login for the account
    LastLogin dateTime Date of the previous login with this account
    VersionUpdateRequired boolean Defines whether application has to be updated

    Examples

    Request

    {
      "email": "string",
      "userName": "string",
      "password": "string",
      "options": {
        "appName": "string",
        "applicationToken": "string",
        "deviceId": "string",
        "pushToken": "string",
        "setCookie": boolean
      }
    }

    Response

    {
      "d": {
        "Code": int,
        "IsSuccess": boolean,
        "Key": "string",
        "Message": "string",
        "Number": "string",
        "CredentialsHeaderName": "string",
        "CredentialsToken": "string",
        "EncodedCookie": "string",
        "IsDeviceActivated": boolean,
        "IsDeviceBlocked": boolean,
        "IsDeviceRegistered": boolean,
        "IsDeviceRegistrationRequired": boolean,
        "IsFirstLogin": boolean,
        "LastLogin": dateTime,
        "VersionUpdateRequired": boolean
      }
    }