YM REST Services

<back to all web services

ProductsDto

Requires Authentication
Requires any of the roles:admin, oauthadminRequires any of the permissions:/admin/store/, /admin/events/
The following routes are available for this service:
POST/Ams/{ClientID}/ProductsCreate Store Product.
PUT/Ams/{ClientID}/ProductsUpdate Store Product.
ProductsDto Parameters:
NameParameterData TypeRequiredDescription
ProductIDbodyintNo
DetailsbodyProductDetailsNo
DisplayOptionsbodyProductDisplayOptionsNo
ItemOptionsbodyItemOptionsNo
PricingOptionsbodyPricingNo
FinancialbodyFinancialNo
FreestonebodyFreestoneProductNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ProductDetails Parameters:
NameParameterData TypeRequiredDescription
ProductNameformstringNo
ProductCodeformstringNo
ProductActiveformboolNo
PrimaryCategoryformstringNo
ProductDescriptionformstringNo
ProductTypeformintNo
ProductDisplayOptions Parameters:
NameParameterData TypeRequiredDescription
IsFeaturedformboolNo
ListInStoreformbool?No
BuyFromStoreformbool?No
TagLineformstringNo
ProductGroupformstringNo
ItemOptions Parameters:
NameParameterData TypeRequiredDescription
RequireCustomerResponseformboolNo
SpecialInstructionsformstringNo
SizeTypeformstringNo
ColorOptionsformstringNo
CustomFieldNameformstringNo
CustomFieldOptionsformstringNo
Pricing Parameters:
NameParameterData TypeRequiredDescription
ChargeTaxVATformboolNo
ShippingWeightformdoubleNo
ShippingSurchargeformdecimalNo
NonMemberUnitPriceformdecimal?No
MemberPricingformList<MemberPricing>No
MemberPricing Parameters:
NameParameterData TypeRequiredDescription
MemberTypeCodeformstringNo
UnitPriceformdecimal?No
ListInStoreformbool?No
BuyFromStoreformbool?No
Financial Parameters:
NameParameterData TypeRequiredDescription
GLCodeformstringNo
QuickBooksClassformstringNo
FreestoneProduct Parameters:
NameParameterData TypeRequiredDescription
IsFreestoneProductformboolNo
ProductTypeIdformint?No
CourseTypeIdformint?No
ProductsDto Parameters:
NameParameterData TypeRequiredDescription
ProductIDbodyintNo
DetailsbodyProductDetailsNo
DisplayOptionsbodyProductDisplayOptionsNo
ItemOptionsbodyItemOptionsNo
PricingOptionsbodyPricingNo
FinancialbodyFinancialNo
FreestonebodyFreestoneProductNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"ProductID":0,"Details":{"ProductName":"String","ProductCode":"String","ProductActive":false,"PrimaryCategory":"String","ProductDescription":"String","ProductType":0},"DisplayOptions":{"IsFeatured":false,"ListInStore":false,"BuyFromStore":false,"TagLine":"String","ProductGroup":"String"},"ItemOptions":{"RequireCustomerResponse":false,"SpecialInstructions":"String","SizeType":"String","ColorOptions":"String","CustomFieldName":"String","CustomFieldOptions":"String"},"PricingOptions":{"ChargeTaxVAT":false,"ShippingWeight":0,"ShippingSurcharge":0,"NonMemberUnitPrice":0,"MemberPricing":[{"MemberTypeCode":"String","UnitPrice":0,"ListInStore":false,"BuyFromStore":false}]},"Financial":{"GLCode":"String","QuickBooksClass":"String"},"Freestone":{"IsFreestoneProduct":false,"ProductTypeId":0,"CourseTypeId":0},"UsingRedis":true,"AppInitTime":"2025-01-15T07:15:51.0689367-05:00","ServerID":"WS-5-99-907","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-15T09:09:47.6269830-05:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ProductID":0,"Details":{"ProductName":"String","ProductCode":"String","ProductActive":false,"PrimaryCategory":"String","ProductDescription":"String","ProductType":0},"DisplayOptions":{"IsFeatured":false,"ListInStore":false,"BuyFromStore":false,"TagLine":"String","ProductGroup":"String"},"ItemOptions":{"RequireCustomerResponse":false,"SpecialInstructions":"String","SizeType":"String","ColorOptions":"String","CustomFieldName":"String","CustomFieldOptions":"String"},"PricingOptions":{"ChargeTaxVAT":false,"ShippingWeight":0,"ShippingSurcharge":0,"NonMemberUnitPrice":0,"MemberPricing":[{"MemberTypeCode":"String","UnitPrice":0,"ListInStore":false,"BuyFromStore":false}]},"Financial":{"GLCode":"String","QuickBooksClass":"String"},"Freestone":{"IsFreestoneProduct":false,"ProductTypeId":0,"CourseTypeId":0},"UsingRedis":true,"AppInitTime":"2025-01-15T07:15:51.0689367-05:00","ServerID":"WS-5-99-907","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-15T09:09:47.6269830-05:00","Device":"Desktop"}