YM REST Services

<back to all web services

ShippingMethods

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:/admin/store/
The following routes are available for this service:
GET/Ams/{ClientID}/ShippingMethodsReturn the shipping methods for this client - with cache.
ShippingMethods Parameters:
NameParameterData TypeRequiredDescription
idqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ShippingMethodsResponse Parameters:
NameParameterData TypeRequiredDescription
shippingMethodsformList<ShippingMethod>No
ShippingMethod Parameters:
NameParameterData TypeRequiredDescription
idformintNo
methodformstringNo
basePriceformdoubleNo
pricePerWeightUnitformdoubleNo
shippingGLCodeformstringNo
isDefaultformboolNo
shippingQBClassformstringNo
allowPromoCodeformboolNo

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.

GET /Ams/{ClientID}/ShippingMethods HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":"2024-05-03T03:46:39.8151879-04:00","ServerID":"WS-4-7-585","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-03T06:20:37.2992272-04:00","Device":"Desktop"}