shipping_rules library

The v4 shipping rules family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/shipping_rules.dart' as shipping_rules;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

SettingsShippingRule

The settings shipping rule body, under shipping_rule.

SettingsShippingRuleConfiguration

A SettingsShippingRule's configuration.

SettingsShippingRuleList

One page of SettingsShippingRule records, under data.

ShippingRulesResource

The shipping rules endpoints with client already applied.

ShippingRulesUrls

Functions

createSettingsShippingRule(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingRule>>

POST /api/{api_version}/settings/shipping_rules

createSettingsShippingRuleConfiguration(ExsitedClient client, Object shippingRuleId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingRule>>

POST /api/{api_version}/settings/shipping_rules/{shipping_rule_id}/configuration

deleteSettingsShippingRule(ExsitedClient client, Object shippingRuleId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/shipping_rules/{shipping_rule_id}

getSettingsShippingRule(ExsitedClient client, Object shippingRuleId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingRule>>

GET /api/{api_version}/settings/shipping_rules/{shipping_rule_id}

getSettingsShippingRules(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingRuleList>>

GET /api/{api_version}/settings/shipping_rules

updateSettingsShippingRule(ExsitedClient client, Object shippingRuleId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsShippingRule>>

PATCH /api/{api_version}/settings/shipping_rules/{shipping_rule_id}