YM REST Services

ShippingMethods

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Required permission:	/admin/store/

The following routes are available for this service:
GET	/Ams/{ClientID}/ShippingMethods	Return the shipping methods for this client - with cache.

**ShippingMethods** Parameters:
Name	Parameter	Data Type	Required	Description
id	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

**ShippingMethodsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
shippingMethods	form	List<ShippingMethod>	No

**ShippingMethod** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
method	form	string	No
basePrice	form	double	No
pricePerWeightUnit	form	double	No
shippingGLCode	form	string	No
isDefault	form	bool	No
shippingQBClass	form	string	No
allowPromoCode	form	bool	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}/ShippingMethods HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	shippingMethods: 
	[
		{
			id: 0,
			method: String,
			basePrice: 0,
			pricePerWeightUnit: 0,
			shippingGLCode: String,
			isDefault: False,
			shippingQBClass: String,
			allowPromoCode: False
		}
	],
	id: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:46:04.6467430-05:00,
	ServerID: WS-6-64-014,
	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:49:37.3732097-05:00,
	Device: Desktop
}