Returns > Return Policies > returnPoliciesModify
Commerce APIReturnsReturn PoliciesreturnPoliciesModify
returnPoliciesModify
POST:return_policies.json

Description

Modify one or multiple return policies.

Permission bit: "return_policies.modify"

Topic: Return Policies

Arguments

data: [ReturnPolicyModify!]!

Main argument for mutations.


ids: [String!]!

List of return policy ids. See also: Unique Identifiers

Example: ["rp_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

condition: ReturnPolicyConditionCreate


currency: String

Currency code used for all prices defined in the policy

Example: "USD"


enabled: Boolean

Whether this return policy is enabled or not

Example: false


inspection_ids: [String!]


name: String

Name of the return policy

Example: "Domestic (USA) Returns"

Valid when: name's length doesn't exceed 250 characters


priority: Int

Priority of the policy (policy with higher priority is to be evaluated first)

Example: 0


refund_option: ReturnPolicyRefundOption

What kind of refund method is allowed


shipping_options: [ReturnPolicyShippingOptionCreate!]


Result

[ReturnPolicy!]

Preview (typescript)

Loading module