Skip to content

Search the Omeda Knowledge Base

API Standard Constants and Codes

Postal Address Data

The following guidelines apply to handling data from our web service APIs that contain postal address information.

Country Codes

We use the ISO 3166-1 alpha-3 set of country codes in our addresses

State/Region Codes

For US states and Canadian Provinces, we expect data in the form of the two-character state abbreviation.

Postal Code

When providing ZIP code information for US addresses, try to provide a full 10-digit zip code (5 digit, dash, 4 digit) format. Some examples of US ZIP codes:

60062-1234
60601-1000
54445

Address Contact Types

ValueDescription
0Type Not Known
100Business Address
110Home Address

Phone Data

The following guidelines describe conventions for handling phone number contact data. Generally, we do not validate phone information for number of digits, however if alphabetic and certain punctuation characters are present in a phone number the data may be rejected.

Some examples of clean phone data

123 555 1212
123-555-1212
1235551212
1123-555-1212
0252929392001

Some examples of bad phone data:

123.555.1212
1235551212 m
123-555-1212 mobile
800-call-joe

Phone Contact Types

ValueDescription
0Type Not Known
200Business Phone
210Home Phone
230Mobile Phone
240Fax
250Foreign Phone
260Foreign Fax
270Pager

Email Data

The following guidelines describe conventions for handling phone number contact data. We employ fairly strict validation on email address data. If the form of an email address is not valid (wrong number of characters, contains illegal characters), the data will be marked as invalid, which could result in the service returning an error, or at least marking the email data as invalid. There are a lot of publicly available email address validation routines, including regular expressions that can be used to implement basic email form validation.

Samples of bad email data:

jsmith@domain.142
1234@doma^in.com
jsmith@domain.foo.bar.biz.com

Email Contact Types

ValueDescription
0Type Not Known
300Primary (Business) Email Address
310Secondary (Home) Email Address

Product Data

Use the below table to decode the “ProductType” element that is returned from the Brand Comprehensive Lookup Service.

Product Types

ValueDescription
1Magazine
2Newsletter
3Event
4Catalog
5Email Deployment
6Association Membership
7Website
8Newsstand
9Accounting
10Sales

Payment Status Codes

Use the below table to decode the “PaymentStatus” element that is returned from the Customer Subscriptions Lookup By Customer Id.

valuedescriptionwhat it means
1Paid on invoice.Customer paid after being invoiced.
2Paid with order.Customer paid at the time of his order.
3Credit.Customer owes an outstanding balance on the subscription.
5Grace.Customer subscription is in grace.
6Free.Customer is being granted a free subscription, but isn’t necessarily qualified by the publisher.
7Controlled.Customer was selected by publisher to receive subscription for free.
8Free Term.Customer was granted a paid subscription at no cost. (free with expire date, formerly known as comp)

Subscription Class Codes

Use the below table to decode the “PaymentStatus” element that is returned from the Customer Subscription Lookup By Customer Id.

valueDescriptionConsidered Active?applies to
1Active. For controlled magazine products, 1 denotes Active Controlled.yesAll product types.
2Active Non-QualifiedyesOnly products with paid circulation.
3Qualified ReservenoOnly products with controlled circulation.
8Soft controlled killsnoOnly products with controlled circulation.
9Controlled killsnoOnly products with controlled circulation.
10ACS kills (Address Correction Service)noOnly products having subscription address delivery.
20Expire suspendsnoSubscription based products having an expiration date.
21Future startsnoSubscription based products having an expiration date.
21Postal suspendsnoOnly products having subscription address delivery.
23Credit SuspendsnoSubscription based paid products.
24Requested SuspendsnoAny product type.
25Kill/RefundsnoSubscription based paid products.
50PassalongnoAny product type.

Credit Card Type Codes

Use the below table to provide the “CreditCardType” element to Save Customer and Order Paid API.

valueDescription
1Visa
2Mastercard
3American Express
4Discover
5Diners Club
104Euro Card
Table of Contents
Knowledge Base Feedback