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 .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}/ShippingMethods HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-03T01:23:34.4285027-04:00","ServerID":"WS-4-69-031","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-03T02:12:11.1310154-04:00","Device":"Desktop"}