{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b7c8120a-504a-492e-95b1-565343da0fe6","name":"Datitude Data API","description":"The following documentation gives examples on how to use the Datitude Data API.\n\nThe provided examples show's and example for each of the possible functions of the API\n\nAuthorization is provided using Basic authentication headers which are generated from a supplied username and API key. To get your username and API key created please contact support: [support@datitude.co.uk](mailto:support@datitude.co.uk)\n\n**The data fields of the Data API:**\n\n| **Field Name** | **Purpose** |\n| --- | --- |\n| customer_id | The ID of the Customer in the Datitude Platform |\n| email | The Customer emails address |\n| title | The Customers Title |\n| first_name | The Customers First Name |\n| last_name | The Customers Last Name |\n| home_telephone | The Home telephone number of a customer |\n| work_telephone | The Work telephone number of a customer |\n| mobile_telephone | The Mobile telephone number of the customer |\n| contact_address_1 | The contact address line 1 for the customer |\n| contact_address_2 | The contact address line 2 for the customer |\n| contact_address_3 | The contact address line 3 for the customer |\n| contact_address_4 | The contact address line 4 for the customer |\n| contact_address_5 | The contact address line 5 for the customer |\n| contact_address_6 | The contact address line 6 for the customer |\n| contact_postcode | The contact address postcode for the customer |\n| contact_country | The contact address country for the customer |\n| contact_country_code | The contact address ISO Country code |\n| mailing_address_1 | The mailing address line 1 for the customer.  <br>  <br>The Mailing address is source from the other customer address that we hold. The mailing address is chose form the customer's contact, billing or delivery address depending on address quality. |\n| mailing_address_2 | The mailing address line 2 for the customer. |\n| mailing_address_3 | The mailing address line 3 for the customer. |\n| mailing_address_4 | The mailing address line 4 for the customer. |\n| mailing_address_5 | The mailing address line 5 for the customer. |\n| mailing_address_6 | The mailing address line 6 for the customer. |\n| mailing_postcode | The mailing postcode for the customer. |\n| mailing_postcode_no_white_space | The mailing postcode without whitespace customer. |\n| mailing_country | The mailing country for the customer |\n| mailing_country_code | the mailing address ISO Country code |\n| mailing_paf_code | Contains one of the following values:  <br>  <br>Not Matched  <br>PAF Matched  <br>  <br>Not matched means we have been unable to validate the address against the Royal Mail address data  <br>  <br>PAF matched mean that the address was matched to a Royal mail address. |\n| mailing_suppression | This shows if the customer has been suppressed from contacting. This field will contain 4 possible values:  <br>  <br>Suppression Match on Address  <br>Suppression Match ON eMail  <br>Suppression Match on Customer ID  <br>Not Suppressed  <br>  <br>The **Not Suppressed** value show that a customer is not suppressed and can be contacted.  <br>  <br>Any value with suppression means the customer should not be contacted |\n| dedupe_key_line_1_postcode_country | A dedupe key used internally to dedupe customer address data. |\n| dedupe_key_line_2_postcode_country | A dedupe key used internally to dedupe customer address data. |\n| dedupe_key_line_1_2_postcode_country | A dedupe key used internally to dedupe customer address data. |\n| dedupe_key_lastname_line_1_2_postcode_country | A dedupe key used internally to dedupe customer address data. |\n| email_subscriber | T or F.  <br>  <br>Shows if the customer subscribed to email. |\n| catalogue_subscriber | T or F.  <br>  <br>Shows if the customer subscribed to catalogues/mailings. |\n| third_party_subscriber | T or F.  <br>  <br>Shows if the customer is subscribed to be contacted by selected third party's. |\n| frequency_segment | The frequency segment of the customer as part of the RFM model |\n| recency_segment | The recency segment of the customer as part of the RFM model |\n| monetary_segment | The monetary segment of the customer as part of the RFM model |\n| active_frequency_segment | The active frequency segment of the customer as part of the RFM model.  <br>  <br>Active is defined by the retailer as a number of months back from the current date. Typically the last 12 months. |\n| active_recency_segment | The active frequency segment of the customer as part of the RFM model.  <br>  <br>Active is defined by the retailer as a number of months back from the current date. Typically the last 12 months. |\n| active_monetary_segment | The active monetary segment of the customer as part of the RFM model.  <br>  <br>Active is defined by the retailer as a number of months back from the current date. Typically the last 12 months. |\n| nursery_segment | The nursery segment of the customer.  <br>  <br>This relates to recent/new customers. |\n| segmentation_cell | A retailer defined segment based on RFM rules set. |\n| creation_date | The Creation Date of the customers account |\n| first_order_id | The First order id for the customer |\n| first_order_date | The first date the customer placed and order |\n| first_order_net_demand_value | The customer first order demand value excluding taxes |\n| first_order_gross_demand_value | The customer first order demand value including taxes |\n| monetary_segment_of_first_order | The customers monetary segment of their first order. |\n| second_order_id | The customers second order id |\n| second_order_date | The customer second order date |\n| second_order_net_demand_value | The customer second order demand value excluding taxes |\n| second_order_gross_demand_value | The customer second order demand value including taxes |\n| monetary_segment_of_second_order | The customers monetary segment of their second order. |\n| days_to_second_order | The number of days elapsed between the customer first and second order |\n| last_order_id | The customer most recent order id |\n| last_order_date | the customer most recent ordered date |\n| last_order_net_demand_value | The customer most recent order demand value excluding taxes |\n| last_order_gross_demand_value | The customer most recent order demand value including taxes |\n| monetary_segment_of_last_order | The customers monetary segment of their most recent order. |\n| offline_campaign_that_customer_was_acquired_from | The Offline campaign that the customer was first seen in. Normally some sort of catalogue campaign/physical mailing |\n| online_campaign_that_customer_was_acquired_from | The Online campaign the customer was acquired was, typically either a Facebook or Google Ad Campaign |\n| online_source_that_customer_was_acquired_from | The UA source the customer was first seen in. |\n| online_medium_that_customer_was_acquired_from | The UA medium the customer was first seen in. |\n| online_channel_that_customer_was_acquired_from | The UA channel the customer was first seen in. |\n| offline_source_that_customer_was_acquired_from | The offline source the customer was first seen in. e.g Direct Mail. |\n| lifetime_order_count | The total number of orders placed by the customer |\n| active_order_count | The total number of orders during the defined active period.  <br>  <br>Typically this is 12 months |\n| gender | The gender of the customer |\n| date_of_birth | The date of birth of the customer |\n| age_in_years | The age in years of the customer, based of their date of birth |\n| age_band | The age band of the customer. |\n| staff_group | The staff group of the customer |\n| loyalty_group | The loyalty group of the customer |\n| reseller_group | the reseller group of the customer |\n| billing_address_1 | The customers billing address line 1 |\n| billing_address_2 | The customers billing address line 2 |\n| billing_address_3 | The customers billing address line 3 |\n| billing_address_4 | The customers billing address line 4 |\n| billing_address_5 | The customers billing address line 5 |\n| billing_address_6 | The customers billing address line 6 |\n| billing_postcode | The customers billing postcode |\n| billing_country | The customers billing country |\n| billing_country_code | The customers billing ISO Country code |\n| delivery_address_1 | The customers delivery address line 1 |\n| delivery_address_2 | The customers delivery address line 2 |\n| delivery_address_3 | The customers delivery address line 3 |\n| delivery_address_4 | The customers delivery address line 4 |\n| delivery_address_5 | The customers delivery address line 5 |\n| delivery_address_6 | The customers delivery address line 6 |\n| delivery_postcode | The customers delivery postcode |\n| delivery_country | The customers delivery country |\n| delivery_country_code | The customers delivery ISO country Code |\n| customer_first_order_was_promotion | T or F  <br>Did the customer first order contain a promotion |\n| customer_first_order_was_markdown | T or F  <br>Did the customer first order contain an item with markdown applied |\n\nThe above fields can be requested from any of the endpoints by simply adding them to the Query request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"21345270","team":3578575,"collectionId":"b7c8120a-504a-492e-95b1-565343da0fe6","publishedId":"VUjTkP4S","public":true,"publicUrl":"https://apidocs.datitude.co.uk","privateUrl":"https://go.postman.co/documentation/21345270-b7c8120a-504a-492e-95b1-565343da0fe6","customColor":{"top-bar":"70C0BA","right-sidebar":"303030","highlight":"DE316A"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2022-08-16T11:18:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/045cc35d6dc7d4cbc4589620be6f96a86089779e5b9c2702e239f2f0c001c7a6","favicon":"https://res.cloudinary.com/postman/image/upload/v1654613341/team/s9h5rjqosumddayvwksi.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.datitude.co.uk/view/metadata/VUjTkP4S"}