| Requires any of the roles: | admin, oauthadmin | Required permission: | /admin/store/ |
| GET | /Ams/{ClientID}/ShippingMethods | Return the shipping methods for this client - with cache. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| shippingMethods | form | List<ShippingMethod> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=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":"2025-01-15T05:45:36.4684538-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:45:11.8752521-05:00","Device":"Desktop"}