Search the Omeda Knowledge Base
-
-
-
-
- Behavior Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By Customer Id
- Customer Lookup By Email Address
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By Name and Country
- Customer Lookup By PostalAddressId
- Customer Merge History Lookup
- Demographic Lookup By Customer Id
- Email Address Lookup By Customer Id
- External ID Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Subscription Lookup By Customer Id
- Subscription Lookup By Email
- Customer Lookup by Hashed Email Address
- Order History Lookup by Customer Id
- Show all articles ( 4 ) Collapse Articles
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Content Lookup
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Show all articles ( 6 ) Collapse Articles
-
-
-
- Release Notes for V20.17
- Release Notes for V20.16
- Release Notes for V20.15
- Release Notes for V20.14
- Release Notes for V20.13
- Release Notes for V20.12
- Release Notes for V20.11
- Release Notes for V20.10
- Release Notes for V20.9
- Release Notes for V20.8
- Release Notes for V20.7
- Release Notes for V20.6
- Release Notes for V20.5
- Release Notes for V20.4
- Release Notes for V20.3
- Release Notes for V20.2
- Release Notes for V20.1
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.17
- Release Notes for V19.16
- Release Notes for V19.15
- Release Notes for V19.14
- Release Notes for V19.13
- Release Notes for V19.12
- Release Notes for V19.11
- Release Notes for V19.10
- Release Notes for V19.9
- Release Notes for V19.8
- Release Notes for V19.7
- Release Notes for V19.6
- Release Notes for V19.5
- Release Notes for V19.4
- Release Notes for V19.3
- Release Notes for V19.2
- Release Notes for V19.1
- Show all articles ( 2 ) Collapse Articles
-
-
-
-
- Customer Olytics Data
- Form Listener
- Olytics - Integration Description
- Olytics - Product Outline
- Olytics Comprehensive Lookup
- Olytics Customer Search
- Olytics Customer Top Values
- Reports - Web Behavior Reporting
- Web Behavioral Tracking (Olytics) - Overview & Capabilities
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- Email - Clickbot Reporting
- Reports - Audience Builder (OnQ) Reporting
- Reports - Audience Overlap Report
- Reports - Audience Report
- Reports - Data Tracker Reporting
- Reports - Email Reporting
- Reports - Issue Activity Reporting
- Reports - Web Behavior Reporting
- Reports - Overview
- Reports- FAQs
- Reports - Email Device and Client Type Reporting
-
-
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Email - Checklist for Sends Created via API Calls
- Show all articles ( 6 ) Collapse Articles
- Email Services - Overview & Capabilities
- Email Builder - User Guide
- Email - Deployment Checklist & Best Practices
- Omeda - Getting Support
- Email - Advanced Features
- Email - A/B Testing
- Email - Appending Lists On Triggered Deployments
- Email - Assigning Link Tracking Categories
- Email - Automated ACS Notifications
- Email - Deliverability
- Email - Dynamic Content
- Email - FAQs
- Email - Glossary
- Email - Link Tracking Errors
- Email - Merge Variables
- Email - Preference Page
- Email - Recurring Deployments
- Email - Triggered Deployments
- Email - User Set-up
- Email - Web Tracking
- Email - Web Tracking String Parameter Definitions
- Email Builder - Getting Started
- Email - Stealth Link
- Email - Clickbot Reporting
- Email - Validation Services
- Email - Opt-Out Footer Merge Variable
- Reports - Email Reporting
- Email - Whitelisting Email Newsletters
- Email - Request a New Deployment Type
- Email - Behavioral Data
- Email - Deployment Defaults
- Email - Deployment Type Creation
- Email - Automation for Email Sending
- Show all articles ( 18 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Email Element
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Pathfinder Element
- Odyssey - Google Ad Manager Element
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Goal Element
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Email Merge Variables
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Merging Paths
- Odyssey - Creating Custom Templates
- Odyssey - Voyage Templates
- Odyssey - Editing an In Progress Voyage
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
-
-
-
-
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - Match Evaluation
- Audience Builder (OnQ) - Overview
- Audience Builder (OnQ) - Query Result Outputs
- Reports - Audience Builder (OnQ) Reporting
- Email - Behavioral Data
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- How to conditionally display a question on your form (video)
- How to create and add an email confirmation to your form (video)
- How to update a demographic (video)
- How To Use A/B Testing on your Dragon Webform (video)
- How To Use Progressive Profiling
- How to send a user back to your website after form submission (redirect to a return URL)
- Best practices for testing forms
- Dragon Forms URL Structure and Appending Parameters
- Form Builder (Dragon) - Overview
- Form Builder (Dragon) Themes
- Form Builder ADA Compliance
- Styling Your Dragon Webforms
- Test links v. live links
- Using a Custom Domain for your Dragon Webform
- Using Dragon Form Builder to capture a Behavior Subscription Attribute
- 2020 Form Builder Updates
- Form Builder - Using Campaign Promo Codes
-
-
-
- Knowledge Base Home
- Documentation
- API & Webservices
- Utility APIs
- Postal Info Lookup
Postal Info Lookup
Summary
The Postal Information API returns postal information for a given postal code. The postal data is updated as available from the USPS, and field definitions can be found here:
http://www.zip-codes.com/zip_database_fields.asp
Base Resource URI
For Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/postalinfo/* For Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/postalinfo/*
- brandAbbreviation
- is the abbreviation for the brand to which the data is being posted.
Technical Requirements
The HTTP header must contain the following elements:
- x-omeda-appid
- a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
- content-type
- a content type supported by this resource. See Supported Content Types for more details. If omitted, the default content type is application/json.
Supported Content Types
There are three content types supported. If omitted, the default content type is application/json.
- JSON
- application/json
- XML
- application/xml, text/xml
JSON is the preferred data exchange format, because it is lightweight and, in most cases, faster to process and utilizes less bandwidth. There are many available open-source JSON libraries available. See json.org for details.
Supported HTTP Methods
There is one HTTP method supported:
- POST
- See W3C’s POST specs for details.
Field Definition
The following tables describe the data elements that can be included in the POST method to lookup data in the database.
PostalInfo Element
Attribute Name | Required? | Description |
---|---|---|
PostalInfo | required | Array element containing one postal code element (see below). |
Postal Info Element
Attribute Name | Required? | Description |
---|---|---|
ZipCode | required | The zip code for which you are requesting information about. Field definitions found here: http://www.zip-codes.com/zip_database_fields.asp |
Request Examples
JSON Example
{ "PostalInfo": [ { "ZipCode": 60062 } ] }
Response Examples
Two responses are possible: a successful POST (200 OK Status) or a failed POST (400 Bad Request/403 Forbidden/404 Not Found/405 Method Not Allowed Statuses). See W3C’s Status Codes.
Successful Submission
A successful POST submission will return postal information for the given zip code. This will require parsing to retrieve the information you require.
JSON Example
{ "PostalInformation":[ { "zipCode":"60062", "primaryRecord":"P", "population":40392, "householdsPerZipcode":15445, "whitePopulation":35220, "blackPopulation":283, "hispanicPopulation":873, "asianPopulation":4237, "hawaiianPopulation":3, "indianPopulation":15, "otherPopulation":203, "malePopulation":19503, "femalePopulation":20889, "personsPerHousehold":2.63, "averageHouseValue":361100, "incomePerHousehold":89164, "latitude":42.11997400, "longitude":-87.84092200, "elevation":596, "state":"IL", "stateFullName":"Illinois", "cityType":"P", "cityAliasAbbreviation":"", "areaCode":"224/312/630/708/847", "city":"NORTHBROOK", "cityAliasName":"NORTHBROOK", "county":"COOK", "countyFips":"031 ", "stateFips":"17", "timeZone":"6 ", "dayLightSaving":"Y", "msa":"1602", "pmsa":"1600", "csa":"176", "cbsa":"16980", "cbsaDiv":"16974", "cbsaType":"Metro", "cbsaName":"Chicago-Naperville-Joliet IL-IN-WI", "msaName":"Chicago-Gary-Kenosha IL-IN-WI CMSA", "pmsaName":"Chicago IL PMSA", "region":"Midwest", "division":"East North Central", "mailingName":"Y", "preferredLastLineKey":"W14201", "classificationCode":" ", "multiCounty":" ", "csaname":"Chicago-Naperville-Michigan City, IL-IN-WI", "cbsaDivName":"Chicago-Joliet-Naperville, IL", "cityStateKey":"W14201", "cityAliasCode":"", "cityMixedCase":"Northbrook", "cityAliasMixedCase":"Northbrook", "stateAnsi":"17", "countyAnsi":"031" } ] }