YM REST Services

<back to all web services

StoreOrderDetails

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/StoreOrderDetailsStore Order items lookup - with cache.Returns all Store Orders for given criteria.
StoreOrderDetails Parameters:
NameParameterData TypeRequiredDescription
DateFromqueryDateTimeNo
PageSizequeryintNo
PageNumberqueryintNo
OffSetqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
StoreOrderDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
StoreOrderDetailsListformList<StoreOrderDetailData>No
StoreOrderDetailData Parameters:
NameParameterData TypeRequiredDescription
OrderIDformintNo
InvoiceNumberformintNo
DatePurchasedformDateTimeNo
OrderStatusformstringNo
ShipLastNameformstringNo
ShipFirstNameformstringNo
CardNameformstringNo
CardTypeformstringNo
PaymentOptionformstringNo
TermsformstringNo
OrderTotalformdoubleNo
BalanceDueformdoubleNo
ShippingTotalformdoubleNo
TaxVATTotalformdoubleNo
TaxVATPercentformdoubleNo
SalesDiscountformdoubleNo
ShippingDiscountformdoubleNo
PromoCodeUsedformstringNo
GiftMessageformstringNo
CategoryformstringNo
ProductCodeformstringNo
ProductformstringNo
PriceformdoubleNo
QuantityformintNo
ChargedTaxVATformstringNo
SizeTypeformstringNo
ColorformstringNo
CustomFieldNameformstringNo
CustomFieldValueformstringNo
CustomerResponseformstringNo
MemberIDformintNo
MemberTypeformstringNo
PrimaryGroupformstringNo
ConstituentIDformstringNo
EmailformstringNo
DateProcessedformDateTimeNo
DateShippedformDateTimeNo
ShipMethodformstringNo
CompanyAttentionformstringNo
ShipAddress1formstringNo
ShipAddress2formstringNo
ShipCityformstringNo
ShipStateformstringNo
ShipPostalformstringNo
ShipProvinceformstringNo
ShipCountryformstringNo
ShipBusPhoneformstringNo
ShipHomePhoneformstringNo
ShipMobilePhoneformstringNo
CardNumberformstringNo
CardMonthformstringNo
CardYearformstringNo
BillAddress1formstringNo
BillAddress2formstringNo
BillCityformstringNo
BillStateformstringNo
BillProvinceformstringNo
BillPostalformstringNo
BillCountryformstringNo
CustomerCommentsformstringNo
InternalCommentsformstringNo
ClosedByformstringNo
OrganizationAttentionformstringNo
BillOrganizationformstringNo
ShipAddressValidatedformboolNo
POformstringNo
MemberAPIGUIDformstringNo
ReferenceNumberformstringNo
EventRegistrationBadgeIDformintNo
EventRegistrationFirstNameformstringNo
EventRegistrationLastNameformstringNo
EventRegistrationAttendeeTypeformstringNo
InvoiceDateformDateTimeNo

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

HTTP + CSV

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/csv

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

{"StoreOrderDetailsList":[{"OrderID":0,"InvoiceNumber":0,"DatePurchased":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","DateShipped":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"DateFrom":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2025-01-15T07:45:29.5231982-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:39:23.6239058-05:00","Device":"Desktop"}