POST:return_policies.json
Commerce APIPOST:return_policies.json

POST:return_policies.json

Description

Modify one or multiple return policies.

Permission bit: "return_policies.modify"

Topic: Return Policies

Query Parameters

ids: Comma-separated array of String, required

List of return policy ids. See also: Unique Identifiers

Example: ?ids=rp_EQzGqWoY,rp_EQzGqWoY


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of ReturnPolicyModify

[
  {
    "condition": {
      "amount": 0,
      "category_id": "ca_EQzGqWoY",
      "conditions": [
        null
      ],
      "country": "",
      "customer_group_id": "cg_EQzGqWoY",
      "operator": "eq",
      "product_id": "pd_EQzGqWoY",
      "quantity": 0,
      "shipping_provider_id": "sp_EQzGqWoY",
      "type": "and",
      "variant_id": "va_EQzGqWoY"
    },
    "currency": "USD",
    "enabled": false,
    "inspection_ids": [
      ""
    ],
    "name": "Domestic (USA) Returns",
    "priority": 0,
    "refund_option": "both",
    "shipping_options": [
      {
        "address": {
          "address1": "Chestnut Street 92",
          "address2": "Apartment 2",
          "city": "Louisville",
          "company": "Google inc.",
          "country": "US",
          "id": "ad_EQzGqWoY",
          "name": "John Smith",
          "phone": "5556251199",
          "plus_code": "PQ7W+WM",
          "province": "KY",
          "zip": "40202"
        },
        "address_type": "custom",
        "inventory_location_id": "il_EQzGqWoY",
        "refund_shipping_charge": true,
        "restock_items_to_inventory": true,
        "return_approval": "automatic",
        "return_fee": "cost_of_label",
        "return_fee_value": 3.1415,
        "reverse_logistics": "custom",
        "reverse_logistics_desc": "TODO",
        "reverse_logistics_name": "TODO",
        "tracking_company": "Ship & Co"
      }
    ]
  }
]

Response Body

Array of ReturnPolicy

Response Body Type

Loading module