Gets the contact.

1 min

GET

http://localhost:64424/episerverapi/commerce/customers/contact/{contactId}

Path Parameters

contactIdstring<uuid>required
Description
Contact ID (GUID).
Format
uuid

Responses

200Return the contact.

EPiServer.ServiceApi.Commerce.Models.Order.ContactModel
Description
Contact model.
- PrimaryKeyIdstring<uuid>
  Example
  00000000-0000-0000-0000-000000000000
  Description
  Contact ID (GUID).
  Format
  uuid
- AddressesEPiServer.ServiceApi.Commerce.Models.Order.AddressModel[]
  Description
  Contacts addresses.
  - AddressIdstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    Address ID (GUID).
    Format
    uuid
  - Modifiedstring<date-time>
    Description
    Last modified date.
    Format
    date-time
  - Namestring
    Description
    Address name.
  - FirstNamestring
    Description
    First name.
  - LastNamestring
    Description
    Last name.
  - CountryNamestring
    Description
    Country name.
  - CountryCodestring
    Description
    Country code.
  - Citystring
    Description
    City.
  - PostalCodestring
    Description
    Postal code (Zip code).
  - Line1string
    Description
    Address line 1.
  - Line2string
    Description
    Address line 2.
  - RegionNamestring
    Description
    Region name.
  - RegionCodestring
    Description
    Region code.
  - Emailstring
    Description
    Email.
  - ShippingDefaultboolean
    Description
    Check if this is default shipping address. This property is misleading and has been obsolete. Use IsShippingAddress instead.
  - BillingDefaultboolean
    Description
    Check if this is default billing address. This property is misleading and has been obsolete. Use IsBillingAddress instead.
  - IsShippingAddressboolean
    Description
    Flag to indicate if this is a shipping address or not.
  - IsBillingAddressboolean
    Description
    Flag to indicate if this is a billing address or not.
  - DaytimePhoneNumberstring
    Description
    Daytime phone number.
  - EveningPhoneNumberstring
    Description
    Evening phone number.
  - Organizationstring
    Description
    Organization name.
  - AddressTypeinteger[]
    Description
    Address type.
- FirstNamestring
  Description
  First name.
- LastNamestring
  Description
  Last name.
- Emailstring
  Description
  Email.
- RegistrationSourcestring
  Description
  Registration source.

401If user does not have enough permission for this request.

404If contact does not exist.

curl

curl --request GET \
     --url http://localhost:64424/episerverapi/commerce/customers/contact/{contactId} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("http://localhost:64424/episerverapi/commerce/customers/contact/{contactId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:64424/episerverapi/commerce/customers/contact/{contactId}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "http://localhost:64424/episerverapi/commerce/customers/contact/{contactId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return the contact.
{
  "PrimaryKeyId": "00000000-0000-0000-0000-000000000000",
  "Addresses": [
    {
      "AddressId": "00000000-0000-0000-0000-000000000000",
      "Modified": "",
      "Name": "",
      "FirstName": "",
      "LastName": "",
      "CountryName": "",
      "CountryCode": "",
      "City": "",
      "PostalCode": "",
      "Line1": "",
      "Line2": "",
      "RegionName": "",
      "RegionCode": "",
      "Email": "",
      "ShippingDefault": false,
      "BillingDefault": false,
      "IsShippingAddress": false,
      "IsBillingAddress": false,
      "DaytimePhoneNumber": "",
      "EveningPhoneNumber": "",
      "Organization": "",
      "AddressType": [
        0
      ]
    }
  ],
  "FirstName": "",
  "LastName": "",
  "Email": "",
  "RegistrationSource": ""
}

401

// If user does not have enough permission for this request.

404

// If contact does not exist.