YM REST Services

StoreOrderDetails

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/StoreOrderDetails	Store Order items lookup - with cache.	Returns all Store Orders for given criteria.

**StoreOrderDetails** Parameters:
Name	Parameter	Data Type	Required
DateFrom	query	DateTime	No
PageSize	query	int	No
PageNumber	query	int	No
OffSet	query	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**StoreOrderDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
StoreOrderDetailsList	form	List<StoreOrderDetailData>	No

**StoreOrderDetailData** Parameters:
Name	Parameter	Data Type	Required
OrderID	form	int	No
InvoiceNumber	form	int	No
DatePurchased	form	DateTime	No
OrderStatus	form	string	No
ShipLastName	form	string	No
ShipFirstName	form	string	No
CardName	form	string	No
CardType	form	string	No
PaymentOption	form	string	No
Terms	form	string	No
OrderTotal	form	double	No
BalanceDue	form	double	No
ShippingTotal	form	double	No
TaxVATTotal	form	double	No
TaxVATPercent	form	double	No
SalesDiscount	form	double	No
ShippingDiscount	form	double	No
PromoCodeUsed	form	string	No
GiftMessage	form	string	No
Category	form	string	No
ProductCode	form	string	No
Product	form	string	No
Price	form	double	No
Quantity	form	int	No
ChargedTaxVAT	form	string	No
SizeType	form	string	No
Color	form	string	No
CustomFieldName	form	string	No
CustomFieldValue	form	string	No
CustomerResponse	form	string	No
MemberID	form	int	No
MemberType	form	string	No
PrimaryGroup	form	string	No
ConstituentID	form	string	No
Email	form	string	No
DateProcessed	form	DateTime	No
DateShipped	form	DateTime	No
ShipMethod	form	string	No
CompanyAttention	form	string	No
ShipAddress1	form	string	No
ShipAddress2	form	string	No
ShipCity	form	string	No
ShipState	form	string	No
ShipPostal	form	string	No
ShipProvince	form	string	No
ShipCountry	form	string	No
ShipBusPhone	form	string	No
ShipHomePhone	form	string	No
ShipMobilePhone	form	string	No
CardNumber	form	string	No
CardMonth	form	string	No
CardYear	form	string	No
BillAddress1	form	string	No
BillAddress2	form	string	No
BillCity	form	string	No
BillState	form	string	No
BillProvince	form	string	No
BillPostal	form	string	No
BillCountry	form	string	No
CustomerComments	form	string	No
InternalComments	form	string	No
ClosedBy	form	string	No
OrganizationAttention	form	string	No
BillOrganization	form	string	No
ShipAddressValidated	form	bool	No
PO	form	string	No
MemberAPIGUID	form	string	No
ReferenceNumber	form	string	No
EventRegistrationBadgeID	form	int	No
EventRegistrationFirstName	form	string	No
EventRegistrationLastName	form	string	No
EventRegistrationAttendeeType	form	string	No
InvoiceDate	form	DateTime	No

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.

GET /Ams/{ClientID}/StoreOrderDetails HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StoreOrderDetailsList: 
	[
		{
			OrderID: 0,
			InvoiceNumber: 0,
			DatePurchased: 0001-01-01,
			OrderStatus: String,
			ShipLastName: String,
			ShipFirstName: String,
			CardName: String,
			CardType: String,
			PaymentOption: String,
			Terms: String,
			OrderTotal: 0,
			BalanceDue: 0,
			ShippingTotal: 0,
			TaxVATTotal: 0,
			TaxVATPercent: 0,
			SalesDiscount: 0,
			ShippingDiscount: 0,
			PromoCodeUsed: String,
			GiftMessage: String,
			Category: String,
			ProductCode: String,
			Product: String,
			Price: 0,
			Quantity: 0,
			ChargedTaxVAT: String,
			SizeType: String,
			Color: String,
			CustomFieldName: String,
			CustomFieldValue: String,
			CustomerResponse: String,
			MemberID: 0,
			MemberType: String,
			PrimaryGroup: String,
			ConstituentID: String,
			Email: String,
			DateProcessed: 0001-01-01,
			DateShipped: 0001-01-01,
			ShipMethod: String,
			CompanyAttention: String,
			ShipAddress1: String,
			ShipAddress2: String,
			ShipCity: String,
			ShipState: String,
			ShipPostal: String,
			ShipProvince: String,
			ShipCountry: String,
			ShipBusPhone: String,
			ShipHomePhone: String,
			ShipMobilePhone: String,
			CardNumber: String,
			CardMonth: String,
			CardYear: String,
			BillAddress1: String,
			BillAddress2: String,
			BillCity: String,
			BillState: String,
			BillProvince: String,
			BillPostal: String,
			BillCountry: String,
			CustomerComments: String,
			InternalComments: String,
			ClosedBy: String,
			OrganizationAttention: String,
			BillOrganization: String,
			ShipAddressValidated: False,
			PO: String,
			MemberAPIGUID: String,
			ReferenceNumber: String,
			EventRegistrationBadgeID: 0,
			EventRegistrationFirstName: String,
			EventRegistrationLastName: String,
			EventRegistrationAttendeeType: String,
			InvoiceDate: 0001-01-01
		}
	],
	DateFrom: 0001-01-01,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T05:45:36.4684538-05:00,
	ServerID: WS-4-27-804,
	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: 2025-01-15T08:40:22.8769826-05:00,
	Device: Desktop
}