YM REST Services

StoreOrders

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

The following routes are available for this service:
GET	/Ams/{ClientID}/StoreOrders	Return a list of order IDs for a specified member that may be optionally filtered by timestamp and status.	This method will return a maximum of 10,000 results.
GET	/Ams/{ClientID}/Member/{MemberID}/StoreOrders	Return a list of order IDs for the authenticated member that may be optionally filtered by timestamp and status.
GET	/Ams/{ClientID}/StoreOrders/{InvoiceID}	Return the order details, including line items and products ordered, of a store order.
GET	/Ams/{ClientID}/Member/{MemberID}/StoreOrders/{InvoiceID}	Return the order details, including line items and products ordered, of a store order placed by the authenticated member.

**StoreOrders** Parameters:
Name	Parameter	Data Type	Required	Description
ProfileID	query	int	No
Timestamp	query	DateTime?	No
Status	query	StoreOrderStatus?	No	Allowable Values Open Processed ShippedClosed Pending Cancelled
StartDate	query	DateTime?	No
EndDate	query	DateTime?	No
InvoiceID	path	string	No
PageSize	query	int?	No
PageNumber	query	int?	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	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

**StoreOrdersResponse** Parameters:
Name	Parameter	Data Type	Required
ServerGmtBias	form	double?	No
ServerTime	form	DateTime?	No
StoreOrderIDList	form	List<StoreOrderID>	No
Profile	form	ProfileDetails	No
Order	form	StoreOrder	No

**StoreOrderID** Parameters:
Name	Parameter	Data Type	Required	Description
InvoiceID	form	string	No

**ProfileDetails** Parameters:
Name	Parameter	Data Type	Required	Description
ID	form	int	No
ConstituentID	form	string	No

**StoreOrder** Parameters:
Name	Parameter	Data Type	Required
OrderID	form	int?	No
InvoiceNumber	form	int?	No
DatePurchased	form	DateTime	No
Terms	form	int	No
TermsLabel	form	string	No
Status	form	StoreOrderStatus	No
StatusLabel	form	string	No
ShipLastName	form	string	No
ShipFirstName	form	string	No
Total	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
MemberType	form	string	No
PrimaryGroup	form	string	No
Email	form	string	No
DateProcessed	form	DateTime?	No
DateShipped	form	DateTime?	No
ShipMethod	form	string	No
CompanyAttention	form	string	No
BusinsessPhone	form	string	No
HomePhone	form	string	No
MobilePhone	form	string	No
CustomerComments	form	string	No
ReferenceNumber	form	string	No
InternalComments	form	string	No
ClosedBy	form	string	No
PO	form	string	No
ShipAddress	form	ShipAddress	No
BillAddress	form	BillAddress	No
LineItems	form	List<LineItem>	No
Products	form	List<StoreOrderProduct>	No

**ShipAddress** Parameters:
Name	Parameter	Data Type	Required
Organization	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Province	form	string	No
PostalCode	form	string	No
Country	form	string	No

**BillAddress** Parameters:
Name	Parameter	Data Type	Required
Organization	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Province	form	string	No
PostalCode	form	string	No
Country	form	string	No

**LineItem** Parameters:
Name	Parameter	Data Type	Required
LineItemID	form	int?	No
LineItemType	form	string	No
LineItemRelatedTo	form	int?	No
LineItemDescription	form	string	No
ProductID	form	int	No
LineItemDate	form	DateTime	No
LineItemAmount	form	double	No
LineItemQuantity	form	int	No
LineTotal	form	double	No
LineItemTaxVATRate	form	double	No
LineItemNotesVisible	form	string	No
GLCodeItemName	form	string	No
LineItemNotesInternal	form	string	No
Payment	form	Payment	No

**Payment** Parameters:
Name	Parameter	Data Type	Required
PaymentMethod	form	PaymentOptions?	No
PaymentMethodLabel	form	string	No
CardName	form	string	No
CardType	form	string	No
CardNumber	form	string	No
CardMonth	form	string	No
CardYear	form	string	No
AchType	form	string	No
AccountNumber	form	string	No
RefNo	form	string	No
Organization	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Province	form	string	No
PostalCode	form	string	No
Country	form	string	No
Phone	form	string	No
Email	form	string	No

**StoreOrderProduct** Parameters:
Name	Parameter	Data Type	Required
LineItemID	form	int?	No
Category	form	string	No
ProductCode	form	string	No
ProductID	form	int?	No
Product	form	string	No
Price	form	double	No
Quantity	form	decimal	No
SizeType	form	string	No
Color	form	string	No
CustomFieldName	form	string	No
CustomFieldValue	form	string	No
CustomerResponse	form	string	No
EventRegistrationBadgeID	form	string	No
EventRegistrationFirstName	form	string	No
EventRegistrationLastName	form	string	No
ProductDescription	form	string	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}/StoreOrders HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	ServerGmtBias: 0,
	ServerTime: 0001-01-01,
	StoreOrderIDList: 
	[
		{
			InvoiceID: String
		}
	],
	Profile: 
	{
		ID: 0,
		ConstituentID: String
	},
	Order: 
	{
		OrderID: 0,
		InvoiceNumber: 0,
		DatePurchased: 0001-01-01,
		Terms: 0,
		TermsLabel: String,
		Status: Open,
		StatusLabel: String,
		ShipLastName: String,
		ShipFirstName: String,
		Total: 0,
		BalanceDue: 0,
		ShippingTotal: 0,
		TaxVATTotal: 0,
		TaxVATPercent: 0,
		SalesDiscount: 0,
		ShippingDiscount: 0,
		PromoCodeUsed: String,
		GiftMessage: String,
		MemberType: String,
		PrimaryGroup: String,
		Email: String,
		DateProcessed: 0001-01-01,
		DateShipped: 0001-01-01,
		ShipMethod: String,
		CompanyAttention: String,
		BusinsessPhone: String,
		HomePhone: String,
		MobilePhone: String,
		CustomerComments: String,
		ReferenceNumber: String,
		InternalComments: String,
		ClosedBy: String,
		PO: String,
		ShipAddress: 
		{
			Organization: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Province: String,
			PostalCode: String,
			Country: String
		},
		BillAddress: 
		{
			Organization: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Province: String,
			PostalCode: String,
			Country: String
		},
		LineItems: 
		[
			{
				LineItemID: 0,
				LineItemType: String,
				LineItemRelatedTo: 0,
				LineItemDescription: String,
				ProductID: 0,
				LineItemDate: 0001-01-01,
				LineItemAmount: 0,
				LineItemQuantity: 0,
				LineTotal: 0,
				LineItemTaxVATRate: 0,
				LineItemNotesVisible: String,
				GLCodeItemName: String,
				LineItemNotesInternal: String,
				Payment: 
				{
					PaymentMethod: NA,
					PaymentMethodLabel: String,
					CardName: String,
					CardType: String,
					CardNumber: String,
					CardMonth: String,
					CardYear: String,
					AchType: String,
					AccountNumber: String,
					RefNo: String,
					Organization: String,
					Address1: String,
					Address2: String,
					City: String,
					State: String,
					Province: String,
					PostalCode: String,
					Country: String,
					Phone: String,
					Email: String
				}
			}
		],
		Products: 
		[
			{
				LineItemID: 0,
				Category: String,
				ProductCode: String,
				ProductID: 0,
				Product: String,
				Price: 0,
				Quantity: 0,
				SizeType: String,
				Color: String,
				CustomFieldName: String,
				CustomFieldValue: String,
				CustomerResponse: String,
				EventRegistrationBadgeID: String,
				EventRegistrationFirstName: String,
				EventRegistrationLastName: String,
				ProductDescription: String
			}
		]
	},
	ProfileID: 0,
	Timestamp: 0001-01-01,
	Status: Open,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	InvoiceID: String,
	PageSize: 0,
	PageNumber: 0,
	MemberID: 0,
	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-03T10:13:50.2483757-04:00,
	Device: Desktop
}

YM REST Services

StoreOrders

Allowable Values

HTTP + JSV