Class ShippingRulesAPI

Shipping Rules API module - /v1/shipping_rules

Hierarchy

ShippingRulesAPI

Index

Constructors

Properties

Methods

create delete edit get getConditionOptions list

Constructors

constructor

new ShippingRulesAPI(client: AxiosInstance): ShippingRulesAPI
Parameters
- client: AxiosInstance
Returns ShippingRulesAPI
- Defined in javascript/src/shipping-rules/api.ts:16

Properties

`Private` client

client: AxiosInstance

Methods

create

create(props: SE.SandboxableMutation<{
shippingRule: SE.ShippingRuleCreateInput;
}>): Promise<AxiosResponse<SE.ShippingRule, any>>
The create method creates a new shipping rule for a given user.
Parameters
- props: SE.SandboxableMutation<{
  shippingRule: SE.ShippingRuleCreateInput;
  }>
Returns Promise<AxiosResponse<SE.ShippingRule, any>>
- Defined in javascript/src/shipping-rules/api.ts:41

delete

delete(props: SE.SandboxableMutation<{
shippingRuleId: string;
}>): Promise<AxiosResponse<any, any>>
The delete method deletes a shipping rule by shippingRuleId.
Parameters
- props: SE.SandboxableMutation<{
  shippingRuleId: string;
  }>
Returns Promise<AxiosResponse<any, any>>
- Defined in javascript/src/shipping-rules/api.ts:50

edit

edit(props: SE.SandboxableMutation<{
shippingRule: SE.ShippingRuleEditInput;
}>): Promise<AxiosResponse<SE.ShippingRule, any>>
The edit method edits a specific shipping rule by shippingRuleId with a new ShippingRule.
Parameters
- props: SE.SandboxableMutation<{
  shippingRule: SE.ShippingRuleEditInput;
  }>
Returns Promise<AxiosResponse<SE.ShippingRule, any>>
- Defined in javascript/src/shipping-rules/api.ts:60

get

get(props?: SE.SandboxableQuery<{
shippingRuleId: string;
}>): Promise<AxiosResponse<SE.ShippingRule, any>>
The get method retrieves a specific shipping rule by shippingRuleId.
Parameters
- Optional props: SE.SandboxableQuery<{
  shippingRuleId: string;
  }>
Returns Promise<AxiosResponse<SE.ShippingRule, any>>
- Defined in javascript/src/shipping-rules/api.ts:32

getConditionOptions

getConditionOptions(props?: {
isSandbox?: boolean;
}): Promise<AxiosResponse<SE.RuleConditionsOptions[], any>>
The getConditionOptions method retrieves the list of condition options availables for creating shipping rules.
Parameters
- Optional props: {
  isSandbox?: boolean;
  }
  - Optional isSandbox?: boolean
Returns Promise<AxiosResponse<SE.RuleConditionsOptions[], any>>
- Defined in javascript/src/shipping-rules/api.ts:73

list

list(props?: {
isSandbox?: boolean;
}): Promise<AxiosResponse<{
shippingRules: SE.ShippingRule[];
}, any>>
The list method retrieves the list of shipping rules by seller.
Parameters
- Optional props: {
  isSandbox?: boolean;
  }
  - Optional isSandbox?: boolean
Returns Promise<AxiosResponse<{
shippingRules: SE.ShippingRule[];
}, any>>
- Defined in javascript/src/shipping-rules/api.ts:23

Generated using TypeDoc