Retrieves the type with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

marketing_segment
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
code

string

Max length: 50
segment

Marketing segment Name

 string

Required

Max length: 50
description

Description of the segment

 string

Max length: 255
visit_frequency_days_interval

Number of days between 2 visits

 integer
frequency_logic

Logic to apply for the frequency, which last events (value can be ORDER,MEETING_COMPLETED or ORDER_OR_MEETING_COMPLETED )

 string
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

 globally unique identifier
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating company_type

 string
sales_organization

Embedded entity "sales_organization" when adding/updating company_type

 sales_organization
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "998be431-f7dd-40a6-a967-ab392644395a",
  "code": "sample string 2",
  "segment": "sample string 3",
  "description": "sample string 4",
  "visit_frequency_days_interval": 5,
  "frequency_logic": "sample string 6",
  "sales_organization_id": "597bb7fb-7374-4ca7-b03f-4173fd7c2296",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "d646a17d-c76c-4150-84c3-8992bf11d5fc",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "570f3772-bed1-4993-b079-6c92a61c912a",
    "db_currency_id": "87a343b6-19d2-45be-a424-45f3bc7229f6",
    "db_language_id": "d313a84e-d1e1-48b6-8be9-795eb0120555",
    "accountancy_code": "sample string 8",
    "archived": true,
    "default_unit_of_measure_system_type": "sample string 10",
    "street": "sample string 11",
    "street2": "sample string 12",
    "street_number": "sample string 13",
    "zip": "sample string 14",
    "city": "sample string 15",
    "email": "sample string 16",
    "phone": "sample string 17",
    "fax": "sample string 18",
    "url": "sample string 19",
    "vat_reg_code": "sample string 20",
    "modified_dateutc": "2025-06-21T12:08:18.7143661+00:00"
  },
  "modified_dateutc": "2025-06-21T12:08:18.7143661+00:00"
}