YM REST Services

<back to all web services

InformzBulkUploadForOrdersRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permissions:/admin/email/, Informz
The following routes are available for this service:
POST/Ams/{ClientID}/InformzBulkUploadForOrdersUpload emails and personal data to Informz for orders.
InformzBulkUploadForOrdersRequest Parameters:
NameParameterData TypeRequiredDescription
GroupNamebodystringNo
DateMinbodystringNo
DateMaxbodystringNo
EventIdbodyint?No
CardFailedbodyboolNo
InvoiceNobodyint?No
PaymentOptionbodyint?No
cdlIDsToExcludebodystringNo
DateSentMinbodystringNo
DateSentMaxbodystringNo
CreatePrintSetbodyboolNo
AdminUserIDbodyint?No
HasOutstandingBalancebodyint?No
DateBalanceMinbodystringNo
DateBalanceMaxbodystringNo
OrganizationbodystringNo
EventRelatedOrdersOnlybodyboolNo
cdlOrderStatusbodystringNo
cdlProductIDbodystringNo
datPaymentAppliedMinbodystringNo
datPaymentAppliedMaxbodystringNo
datPaymentCreatedMinbodystringNo
datPaymentCreatedMaxbodystringNo
NamebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/InformzBulkUploadForOrders HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InformzBulkUploadForOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <AdminUserID>0</AdminUserID>
  <CardFailed>false</CardFailed>
  <CreatePrintSet>false</CreatePrintSet>
  <DateBalanceMax>String</DateBalanceMax>
  <DateBalanceMin>String</DateBalanceMin>
  <DateMax>String</DateMax>
  <DateMin>String</DateMin>
  <DateSentMax>String</DateSentMax>
  <DateSentMin>String</DateSentMin>
  <EventId>0</EventId>
  <EventRelatedOrdersOnly>false</EventRelatedOrdersOnly>
  <GroupName>String</GroupName>
  <HasOutstandingBalance>0</HasOutstandingBalance>
  <InvoiceNo>0</InvoiceNo>
  <Name>String</Name>
  <Organization>String</Organization>
  <PaymentOption>0</PaymentOption>
  <cdlIDsToExclude>String</cdlIDsToExclude>
  <cdlOrderStatus>String</cdlOrderStatus>
  <cdlProductID>String</cdlProductID>
  <datPaymentAppliedMax>String</datPaymentAppliedMax>
  <datPaymentAppliedMin>String</datPaymentAppliedMin>
  <datPaymentCreatedMax>String</datPaymentCreatedMax>
  <datPaymentCreatedMin>String</datPaymentCreatedMin>
</InformzBulkUploadForOrdersRequest>