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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupName: String,
	DateMin: String,
	DateMax: String,
	EventId: 0,
	CardFailed: False,
	InvoiceNo: 0,
	PaymentOption: 0,
	cdlIDsToExclude: String,
	DateSentMin: String,
	DateSentMax: String,
	CreatePrintSet: False,
	AdminUserID: 0,
	HasOutstandingBalance: 0,
	DateBalanceMin: String,
	DateBalanceMax: String,
	Organization: String,
	EventRelatedOrdersOnly: False,
	cdlOrderStatus: String,
	cdlProductID: String,
	datPaymentAppliedMin: String,
	datPaymentAppliedMax: String,
	datPaymentCreatedMin: String,
	datPaymentCreatedMax: String,
	Name: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T05:23:12.6024055-04:00,
	ServerID: WS-6-134-823,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T06:23:07.1095866-04:00,
	Device: Desktop
}