Search the Omeda Knowledge Base

< All Topics
Print

Save Customer and Order Paid

Summary

This API provides the ability to post a complete set of customer identity, contact, and demographic information along with order (paid or controlled) information for data processing (insert/update). Note that this service deposits data into a queue, it does not process data immediately. Back end processing of the data happens through a decoupled processing layer and depends on your own individual database configuration.

Base Resource URI

For Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/storecustomerandorder/*

For Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/storecustomerandorder/*

brandAbbreviationis 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-typea content type supported by this resource. See Supported Content Types for more details.x-omeda-inputida unique id with which to process your request.Contact your Omeda Customer Services Representative to obtain an inputid.

Note: If “WriteInDesc” is used while sending demographic data then Input should be OEC enabled. Ask Account Representative for details.

Supported Content Types

JSONapplication/json

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.

Field Definition

The following tables describe the data elements that can be included in the POST method to store data in the database.

Customer Elements

Attribute NameRequired?Description
ClientCustomerIdoptionalthe id of the customer in the external/interfacing system. This id is assumed to be unique within the brand and is used to lookup the record in the internal database in order to determine whether an insert or update is made. If you plan on using OmedaCustomerId as the way to identify the user, do not pass in this element.
OmedaCustomerIdoptionalthe internal id of the customer. This id is unique. Providing this guarantees that identityresolution processing will be bypassed. You should provide this id only if you are certain that the data provided in this call is definitely associated with the individual specified by the id. If you plan on using ClientCustomerId as the way to identify the user, do not pass in this element.
ExternalCustomerIdoptionalthe external customer id that can be used to identity a customer.
ExternalCustomerIdNamespaceoptionalthe namespace that is associated with which the ExternalCustomerId will be associated with. Please contact your Omeda Account Manager to determine what needs to be sent in here. It is recommended if the ExternalCustomerId is on the request, that this field is also set, otherwise the default will be used, if there is no default an error will be returned.
CustomerStatusIdoptionalthe status of the submitted customer. 0 = Inactive, 1 = Active, 3 = Test
Salutationoptionalsalutation (Ms., Mr. , Dr. etc) of customer, up 10 characters long
FirstNameoptionalfirst name of customer, up to 100 characters long
MiddleNameoptionalmiddle name of customer, up to 100 characters long
LastNameoptionallast name of customer, up to 100 characters long
Suffixoptionalsuffix of customer (Jr. Sr., III, etc.) , up to 10 characters long
Titleoptionaljob title, up to 100 characters long
Genderoptional(M,F) male=M, female=F
SignupDateoptionalTwo formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm. Date the person signed up
ClientOrderIdoptionalClient assigned order ID.This is an integer value.
PromoCodeoptionalPromocode for all product orders in this call,up to 50 char long.
OrderDateoptionalDate of order, If missed, default is today’s date
AddressesoptionalJSON element containing multiple Address elements (see below)
PhonesoptionalJSON element containing multiple Phone elements (see below)
EmailsoptionalJSON element containing multiple Email elements (see below)
CustomerDemographicsoptionalJSON element containing multiple CustomerDemographic elements (see below)
ProductsoptionalJSON element containing multiple Product Elements elements (see below)
TelemarketingoptionalJSON element containing multiple Telemarketing Elements elements (see below)
DonorIdoptionalThis field is used for Gift Subscriptions. DonorId is the OmedaCustomerId of a different existing customer who is giving gift subscription(s). If provided, all subscriptions for this transaction will be considered Gift Subscriptions given by the DonorId customer.
MergeCodeoptionalThis field is used to specify whether the customer record should be mergeable or non-mergeable. When a mergeable record is processed, if another customer record sufficiently matches the merge criteria, the data from both records will be merged into one record. Valid values are “1”, indicating the record is mergeable, and “0”, indicating the record is non-mergeable. If no value is provided, the default value is “1”.

Addresses Elements

Attribute NameRequired?Description
AddressContactTypeoptionalsee Address Contact Types. If none is provided, 100 (business) is assumed.
Companyoptionalif the address contains a company name put it here, up to 255 characters long. Do not use the Street, ApartmentMailStop, or ExtraAddress fields to store company name information.
Streetoptionalfirst line of street address, up to 255 characters long
ApartmentMailStopoptionalapartment, mail stop or suite number, up to 255 characters long
ExtraAddressoptionallast line of street address, only if necessary, up to 255 characters long
Cityoptionalcity name, up to 100 characters long
RegionCodeoptionalFor country_code=’USA’ or ‘CAN’, this must be the 2-character US state or canadian code used by the postal service. Omeda also has region codes for other countries of the world
Regionoptionalname of region. Only used when region_code cannot be given. Should contain the region, up to 100 characters long.
PostalCodeoptionalZIP code or postal code.
CountryCodeoptional3-character country code
CountryoptionalName of country. Only used when country code cannot be provided. Should contain the country, up to 100 characters long.
AddressProductsoptionalComma-separated list of product ids to associate this address with or one of the following keywords; “ALL” (All products), “NONE” (No Products), “ALL_PRINT” (All Products that are of “Magazine” type), “ALL_NEWSLETTER” (All Products that are of “Newsletter” type. If ommitted, default is “NONE”.
AirmailoptionalIf including this entry in the JSON the only valid submissions are “A” or an empty string “”. An empty string is the only way to clear an existing entry of “A”.

Emails Elements

Attribute NameRequired?Description
EmailContactTypeoptionalsee Email Contact Types. If none is provided, 300 (primary/business) is assumed.
EmailAddressrequiredemail address, must be properly formatted
EmailProductsoptionalComma-separated list of product ids to associate this email address with or one of the following keywords; “ALL” (All products), “NONE” (No Products), “ALL_PRINT” (All Products that are of “Magazine” type), “ALL_NEWSLETTER” (All Products that are of “Newsletter” type. If ommitted, default is “NONE”.

Phones Elements

Attribute NameRequired?Description
PhoneContactTypeoptionalsee Phone Contact Types. If none is provided, 200 (business) is assumed.
Numberrequiredphone number
Extensionoptionalseparate extension digits, if known

CustomerDemographics Elements

Attribute NameRequired?Description
OmedaDemographicIdconditionalIdentifier that specifies the explicit omeda demographic ID. This is an integer value. Either the ClientDemographicId or OmedaDemographicId is required.
OmedaDemographicValueconditionalHolds the explicit value id that is associated with the OmedaDemographicId provided above. This is a String value. If OmedaDemographicId is present then OmedaDemographicValue must be present but either the ClientDemographicValue or OmedaDemographicValue is required.
WriteInDescoptional“Other” text description, 100 char max. Only single response and multi response demographics can have values for the WriteInDesc field and only applicable to demographic values with value type of “Other”.

Product Elements

Send in “Product” elements for Magazine and Newsletter type Products to create a subscription for that Product. If the Product is of type “Email Deployment”, you can use the Product Element and include a “Filter” sub-element to create an Opt-In or Opt-Out entry. Alternately, you can use the Optin API or Optout API to send in “Email Deployment” type Products.

Attribute NameRequired?Data TypeDescription
OmedaProductIdconditionalintegerExplicit Omeda product id for the product being requested. Note: If any product information is provided then OmedaProductId must be given.Only Magazines (productType=1) and Newsletters (productType=2) can be updated via this API. Use the OptIn/Optout APIs forEmail Deployment updates (productType=5) and the Assign Behavior API for Event updates (prouductType=3). For a full list of types see Product Types.
Receiveoptionalshort1 = opt-in, 0 = opt-out. Assumed to be 1 if not given. Explicitly allows this order service to capture opt-out behaviors as part of the order transaction.
QuantityoptionalintegerQuantity requested. Assumed to be 1 if not given.
PersonalIdentifieroptionalstringA Personal Identifier for the product. For example, “What is your Eye Color?” Maximum of 50 characters.
RequestedVersionoptionalcharApplicable only for products that have different versions (‘P’ for print, ‘D’ for digital, ‘B’ for both).
ShippingAddressIdoptionalintegerExplicit Omeda postal address id for the customer. Note: if submitted, OmedaCustomerId must be given.
EmailAddressIdoptionalintegerExplicit Omeda email address id for the customer. Note: if submitted, OmedaCustomerId must be given.
TermconditionalintegerTerm (duration) of the subscription. You must specify Term or OrderExpirationDate per paid product.
PricePerQuantityoptionaldecimalPrice per quantity.
DiscountPercentageoptionaldecimalPercentage Discount for order.
PaymentStatusIdoptionalintegerPayment status of the subscription. Omit this element if there is no payment being made. Payment Status Codes
AmountoptionaldecimalTotal amount that will be billed or charged for this transaction (not including shipping or tax).
AmountPaidoptionaldecimalAmount that will be paid immediately as part of this transaction.
SalesTaxoptionaldecimalSales Tax that will be paid as part of this transaction.
PostageoptionaldecimalPostage that will be paid as part of this transaction.
PurchaseOrderNumberoptionalstringA number generated by the client in order to authorize a purchase transaction
StartIssueDateoptionaldateThe starting date of the first issue (yyyy-MM-dd)
OrderExpirationDateconditionaldateExpiration date of the order (yyyy-MM-dd). You must specify Term or OrderExpirationDate per paid product.
AutoRenewalCodeoptionalintegerCode used to indicate automatic subscription renewal type: 0 = No Renewal, 5 = On Expire – Auto-Charge, 6 = On Expire – Send Invoice.For new subscriptions, AutoRenewalCode should be excluded if no auto renewal is needed.
NumberOfInstallmentsoptionalintegerTotal number of installments to receive.
SkuconditionalstringProduct code or tracking number. Required for Single Copy Sales products.

Product Updates Elements

Send in “ProductUpdate” elements for Magazine and Newsletter type Products to update the requested version on a subscription for that Product without changing the verification_date.

Attribute NameRequired?Data TypeDescription
OmedaProductIdUpdateconditionalintegerExplicit Omeda product id for the product being requested. Note: If any product information is provided then OmedaProductIdUpdate must be given.Only Magazines (productType=1) and Newsletters (productType=2) can be updated via this API. Use the OptIn/Optout APIs forEmail Deployment updates (productType=5) and the Assign Behavior API for Event updates (prouductType=3). For a full list of types see Product Types.
RequestedVersionUpdateoptionalcharApplicable only for products that have different versions (‘P’ for print, ‘D’ for digital, ‘B’ for both).

Billing Information Elements

Billing information is only required for paid products.

Attribute NameRequired?Data TypeDescription
CreditCardNumberoptionalstringOnly to be used for 3rd party payment.
New Credit Card Number that will replace the Credit Card Number on file that is related to all Paid Subscriptions for the Customer Id and Product Id. Omeda suggests using Test Credit Cards when testing in our Staging environment
CreditCardTypeconditionalintegerOnly to be used for 3rd party payment.
Required field if CreditCardNumber is submitted. The code associated with the Credit Card Type Valid Values: see Credit Card Type Codes.
ExpirationDateconditionalstringOnly to be used for 3rd party payment.
Required field if CreditCardNumber is submitted. The Expiration Date for the Credit Card Number passed in on the request (MMYY)
CardSecurityCodeconditionalstringOnly to be used for 3rd party payment.
Required field if CreditCardNumber is submitted. The Card Security Code for the Credit Card Number passed in on the request
NameOnCardconditionalstringRequired field if CreditCardNumber is submitted. The Full Name associated with the Credit Card Number passed in on the request.
DoChargerequiredstringThis value should always be “False”.
DepositDateconditionaldateDate that payment was made (yyyy-MM-dd). DepositDate is required for 3rd party payment.
AuthCodeconditionalstringAuthorization code. AuthCode is required for 3rd party payment.
Comment1optionalstringOptional comment which may display on merchant account reports (depending on merchant account). Omeda recommends passing the Magazine name or Brand name into this field.
Comment2optionalstringOptional comment which may display on merchant account reports (depending on merchant account). Omeda recommends passing the OmedaCustomerId into this field for existing customers, or passing the first and last name into this field for new customers.
BillingCompanyoptionalstringBilling Address company name, if any, that needs to be updated. Up to 255 characters long.
BillingStreetrequiredstringFirst line of billing street address that needs to be updated. Up to 255 characters long
BillingApartmentMailStopoptionalstringBilling apartment, mail stop or suite number that needs to be updated. Up to 255 characters long
BillingExtraAddressoptionalstringLast line of street address (only if necessary) associated with the credit card/payment method
BillingCityrequiredstringBilling city name that needs to be updated. Up to 100 characters long
BillingRegionconditionalstringRegion associated with the credit card/payment method. For country_code=’USA’ or ‘CAN’, this must be the 2-character US state or Canadian code used by the postal service. Omeda also has region codes for other countries of the world.BillingRegion is required if BillingCountryCode is USA or Canada.
BillingPostalCodeconditionalstringBilling ZIP code or billing postal code. BillingPostalCode is required if BillingCountryCode is USA or Canada.
BillingCountryCoderequiredstring3-character country code associated with the credit card/payment method
PayPalPaymentIdconditionalstringRequired if PayPalPayerId is submitted. This is the unique paymentId associated with a PayPal payment. Note: PayPal payment credentials must be set up in Portal for this field to be used. Please speak with your account manager for further information. (coming soon 7/5/18)
PayPalPayerIdconditionalstringRequired if PayPalPaymentId is submitted. This is the payerId (an id which belongs to a PayPal account) associated with a PayPal payment. Note: PayPal payment credentials must be set up in Portal for this field to be used. Please speak with your account manager for further information. (coming soon 7/5/18)

Telemarketing Elements

Attribute NameRequired?Data TypeDescription
TelemarketingCompanyrequiredstringName of Telemarketing Company, 100 char max
TelemarketingRecordingIdrequiredstringID needed to locate recording, 50 char max
TelemarketingAgentrequiredstringName/ID of telemarketing agent, 20 char max
PersonalIdQuestionrequiredstringPersonal ID value provided by customer, 100 char max
TimeOfCalloptionaldateTime Call occurred (date/time).Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm.
EndOfCalloptionaldateTime Call ended (date/time).Two formats are available: yyyy-MM-dd and yyyy-MM-dd HH:mm.
LengthOfCalloptionalintegerLength of call in minutes
SpokeToNamerequiredstringName of person the agent spoke to, 100 char max
SpokeToTitlerequiredstringTitle of person the agent spoke to, 100 char max
AuthorizedAssistantResponseoptionalboolean(true/false)Was person spoke to authorized to make a product request (true/false)
GeneralTeleInfooptionalstringMiscellaneous information, 255 char max

Customer Behavior Element

Attribute NameRequired?Description
BehaviorIdRequiredOmeda Event ID (Integer value)
BehaviorDateRequiredDate the behavior occurred (yyyy-MM-dd HH:mm:ss )
BehaviorPromoCodeoptionalPromocode

Test Credit Cards

Depending on your payment vendor, various test credit card numbers are available to simulate credit card transactions in a testing environment. These cards will fail on Production but can be used for testing in Staging.

Paytrace

Credit Card TypeCredit Card NumberSecurity CodeExpire Date
MasterCard5454545454545454998Future Date
Visa4111111111111111999Future Date

PayPal

Credit Card TypeCredit Card NumberSecurity CodeExpire Date
MasterCard5555555555554444AnyFuture Date
MasterCard5105105105105100AnyFuture Date
Visa4111111111111111AnyFuture Date
Visa4012888888881881AnyFuture Date
American Express378282246310005AnyFuture Date
American Express371449635398431AnyFuture Date
Discover6011111111111117AnyFuture Date
Discover6011000990139424AnyFuture Date

Authorize.net

Credit Card TypeCredit Card NumberSecurity CodeExpire Date
MasterCard5424000000000015Any 3-digitFuture Date
Visa4111111111111111Any 3-digitFuture Date
Discover6011000000000012Any 3-digitFuture Date
American Express370000000000002Any 4-digitFuture Date
Diners Club/ Carte Blanch38000000000006Any 3-digitFuture Date
JCB3088000000000017Any 3-digitFuture Date

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 create a Transaction in the data queue. The response has a ResponseInfo element with two sub-elements, a TransactionId element, the Id for the transaction, and a Url element, the URL that allows you to check the status of your transaction. See Transaction Lookup Service for more details.

JSON Example: Comp submission

{
  "CustomerDemographics": [
    {
      "OmedaDemographicId": "3",
      "OmedaDemographicValue": ["37"]
    },
    {
      "OmedaDemographicId": "4",
      "OmedaDemographicValue": ["52"]
    }
  ],
  "Emails": [{
    "EmailProducts": "2",
    "EmailContactType": "300",
    "EmailAddress": "jdoeomeda@mailinator.com"
  }],
  "Addresses": [{
    "Street": "123 Fake St",
    "PostalCode": "60707",
    "AddressContactType": "100",
    "AddressProducts": "2",
    "CountryCode": "USA",
    "Company": "Omeda",
    "City": "Northbrook",
    "RegionCode": "IL"
  }],
  "Products": [{
    "Amount": "0.00",
    "AmountPaid": "0.00",
    "OmedaProductId": 2,
    "Receive": "1",
    "RequestedVersion": "B",
    "Term": "12"
  }],
  "PromoCode": "free",
  "FirstName": "Jane",
  "LastName": "Doe",
  "Title": "Tester"
}

JSON Example: Bill me

For a Bill me transaction, the Credit Card fields are removed from the BillingInformation section, DoCharge is set to “False” in the BillingInformation section, and AmountPaid is removed from the Products section.

{
   "OmedaCustomerId":1234,
   "FirstName":"James",
   "LastName":"Smith",
   "Title":"Orthopaedic Surgeon",
   "PromoCode":"ZZZ2010A23",
   "Addresses":[
      {
         "AddressContactType":"100",
         "Company":"Smith Orthopedics",
         "ApartmentMailStop":"2nd Floor",
         "Street":"555 Huehl Road",
         "ExtraAddress":"Room 34",
         "City":"Northbrook",
         "RegionCode":"IL",
         "PostalCode":"60062-0123",
         "CountryCode":"USA",
         "AddressProducts": "12,13,14"
      }
   ],
   "BillingInformation": {
      "NameOnCard": "James Smith",
      "DoCharge": "False",
      "BillingCompany": "Smith Orthopedics",
      "BillingStreet": "555 Huehl Road",
      "BillingApartmentMailStop": "2nd Floor",
      "BillingCity": "Northbrook",
      "BillingRegion": "IL",
      "BillingPostalCode": "60062",
      "BillingCountryCode": "USA",
      "Comment1": "James Smith",
      "Comment2": "1234"
   },
   "Emails":[
      {
         "EmailContactType":"310",
         "EmailAddress":"jsmith@domain.com",
         "EmailProducts": "12,13,14"
      },
      {
         "EmailContactType":"300",
         "EmailAddress":"owner@smithortho.domain.com",
         "EmailProducts": "12,13,14"
      }
   ],
   "Phones":[
      {
         "PhoneContactType":"200",
         "Number":"847-555-7527",
         "Extension":"72"
      }
   ],
   "CustomerDemographics":[
      {
         "OmedaDemographicId":10001,
         "OmedaDemographicValue":[10002,10001]
      },
      {
         "OmedaDemographicId":10002,
         "OmedaDemographicValue":10003,
         "WriteInDesc":"Other OEC value"
      }
   ],
   "Products":[
      {
         "Amount": "65.00",
         "SalesTax": "6.50",
         "Term": "12",
         "OmedaProductId":14,
         "Receive":1,
         "RequestedVersion":"D",
         "PersonalIdentifier":"test",
         "ShippingAddressId":112,
         "EmailAddressId":1
      }
   ]
}

JSON Example: 3rd party payment

For 3rd party payment, Credit Card information is required, but DoCharge should be false. DepositDate and AuthCode will also be required.

Since the payment should have already been made prior to the order getting to Omeda, if you don’t have (or want) to pass the real CC# to Omeda, a test credit card can be used since no charge will ever actually be made (but credit card information is still currently required to meet the standard format of our API).

{
   "OmedaCustomerId":1234,
   "FirstName":"James",
   "LastName":"Smith",
   "Title":"Orthopaedic Surgeon",
   "PromoCode":"ZZZ2010A23",
   "Addresses":[
      {
         "AddressContactType":"100",
         "Company":"Smith Orthopedics",
         "ApartmentMailStop":"2nd Floor",
         "Street":"555 Huehl Road",
         "ExtraAddress":"Room 34",
         "City":"Northbrook",
         "RegionCode":"IL",
         "PostalCode":"60062-0123",
         "CountryCode":"USA",
         "AddressProducts": "12,13,14"
      }
   ],
   "BillingInformation": {
      "CreditCardType": "1",
      "CreditCardNumber": "4111111111111111",
      "ExpirationDate": "0226",
      "CardSecurityCode": "111",
      "NameOnCard": "James Smith",
      "DoCharge": "False",
      "BillingCompany": "Smith Orthopedics",
      "BillingStreet": "555 Huehl Road",
      "BillingApartmentMailStop": "2nd Floor",
      "BillingCity": "Northbrook",
      "BillingRegion": "IL",
      "BillingPostalCode": "60062",
      "BillingCountryCode": "USA",
      "Comment1": "James Smith",
      "Comment2": "1234",
      "DepositDate": "2016-09-09",
      "AuthCode": "393472480"
   },
   "Emails":[
      {
         "EmailContactType":"310",
         "EmailAddress":"jsmith@domain.com",
         "EmailProducts": "12,13,14"
      },
      {
         "EmailContactType":"300",
         "EmailAddress":"owner@smithortho.domain.com",
         "EmailProducts": "12,13,14"
      }
   ],
   "Phones":[
      {
         "PhoneContactType":"200",
         "Number":"847-555-7527",
         "Extension":"72"
      }
   ],
   "CustomerDemographics":[
      {
         "OmedaDemographicId":10001,
         "OmedaDemographicValue":[10002,10001]
      },
      {
         "OmedaDemographicId":10002,
         "OmedaDemographicValue":10003,
         "WriteInDesc":"Other OEC value"
      }
   ],
   "Products":[
      {
         "Amount": "65.00",
         "AmountPaid": "71.50",
         "SalesTax": "6.50",
         "Term": "12",
         "OmedaProductId":14,
         "Receive":1,
         "RequestedVersion":"D",
         "PersonalIdentifier":"test",
         "ShippingAddressId":112,
         "EmailAddressId":1
      }
   ]
}

Error Response

In the event of an error, an error response will be returned. This will result in an HTTP Status 400 Bad Request/404 Not Found/405 Method Not Allowed.

Potential errors:

ClientCustomerId {clientCustomerId} is not mapped to an existing OmedaCustomerId.
ClientCustomerId {clientCustomerId} is mapped to more than one OmedaCustomerId.
OmedaCustomerId {omedaCustomerId} is not a valid customer.
CustomerStatusId has an invalid value.
The submission contained an invalid AddressContactType {AddressContactType}
The submission contained an invalid EmailContactType {EmailContactType}
The submission contained an invalid PhoneContactType {PhoneContactType}
EmailAddress is not valid {EmailAddress}
Number must be set.
Can't submit more than one of the following: OmedaDemographicId, ClientDemographicId.
OmedaDemographicValue is missing for OmedaDemographicId:{OmedaDemographicId}
ClientDemographicValue is missing for ClientDemographicId: {ClientDemographicId}
OmedaDemographicValue {OmedaDemographicValue} is not a valid value for OmedaDemographicId {OmedaDemographicId}
OmedaDemographicId {omedaDemographicId} is not a valid value.
OmedaProductId is missing in Products submission
Your submission contained an invalid date
To set a ShippingAddressId, your submission must contain an {OmedaCustomerId}.
The ShippingAddressId  {ShippingAddressId} is invalid.
The ShippingAddressId  {ShippingAddressId} does not belong to the Customer submitted.
The ShippingAddressId  {ShippingAddressId} submitted is not Active.
To set an EmailAddressId ,your submission must contain an {OmedaCustomerId}.
The EmailAddressId {EmailAddressId} is invalid.
The EmailAddressId {EmailAddressId} does not belong to the Customer submitted.
The EmailAddressId {EmailAddressId} submitted is not Active.
TelemarketingCompany is missing.
TelemarketingRecordingId is missing.
TelemarketingAgent is missing.
PersonalIdQuestion is missing.
SpokeToName is missing.
SpokeToTitle is missing.
Billing address is incomplete
BillingRegion and BillingPostalCode are required for USA and Canada.
Payment Error: Invalid account number
Amount cannot be less than 0
AmountPaid cannot be less than 0
AmountPaid cannot be greater than total order amount
ExpirationDate should be in the future
The CreditCardNumber and CreditCardType do not match.
Must specify Term or OrderExpirationDate per product.

A failed POST submission error codes:

StatusDescription
400 Bad RequestTypically, this error occurs when the request does not follow the specifications.
403 ForbiddenTypically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid.
404 Not FoundTypically, this error occurs with a malformed URL or the resource that is searched for is not found.
405 Method Not AllowedTypically, this error occurs when the resource accessed is not allowed by the HTTP Method utilized. Make sure you employ the correct HTTP Method (POST) for this request.

This is not an exhaustive list of errors, but common ones. If an error occurs repeatedly, please contact your Omeda representative.

JSON Example

{
  "Errors" : [
    {
      "Error": "The ShippingAddressId 112 does not belong to the Customer submitted"
    }
  ]
}

In the rare case that there is a server-side problem, an HTTP 500 (server error) will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable.Please contact Omeda Account Representative.

Tags:
Table of Contents
Scroll to Top