POST:returns.json

Description

Create one or multiple returns.

Permission bit: "returns.create"

Topic: Returns

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of ReturnCreate

Copy
[
  {
    "customer_balance": false,
    "line_items": [
      {
        "fulfillment_id": "fu_EQzGqWoY",
        "line_item_id": "li_EQzGqWoY",
        "reason": "arrived_damaged",
        "return_quantity": 4,
        "variant_id": "va_EQzGqWoY"
      }
    ],
    "order_id": "or_EQzGqWoY",
    "return_policy_id": "rp_EQzGqWoY",
    "shipping_option_index": 0,
    "tags": [
      ""
    ]
  }
]

Response Body

Array of Return

Response Body Type

Loading module