ReturnGroupSerializer V1

Last updated: July 16, 2025

ReturnGroupSerializer

		Field Name Type Description
`id`	integer	Unique identifier for the return group.
`shop_name`	string	Name of the associated shop.
`order_platform_id`	string	Platform-specific ID for the order.
`order_name`	string	Display name for the order.
`order_created_at`	string	Timestamp of when the order was created.
`order_sales_channel`	string	Sales channel associated with the order.
`customer_name`	string	Name of the customer.
`customer_email`	string	Email address of the customer.
`country`	string	Country of the customer.
`shipment_status`	string (optional)	Status of the shipment.
`carrier`	string (optional)	Carrier handling the shipment.
`tracking_number`	string (optional)	Tracking number for the shipment.
`return_method`	string	Method of return (e.g., mail, in-store).
`credit_method`	string	Credit method used (e.g., refund, store credit).
`is_exchange`	boolean	Indicates whether the return is an exchange.
`is_instant_exchange`	boolean	Indicates whether the exchange is instant.
`return_subtotal`	MoneyBag	Subtotal for the return.
`return_discounted_subtotal`	MoneyBag	Discounted subtotal for the return.
`return_tax_total`	MoneyBag	Total tax for the return.
`return_total`	MoneyBag	Total amount for the return.
`total_refunded`	MoneyBag	Total amount refunded.
`gift_card_order_ids`	list of strings	List of order IDs associated with gift cards.
`returns`	list of `ReturnSerializer`	List of return items included in this group.
`created_at`	string	Timestamp of when the return group was created (default: `1970-01-01T00:00:00Z`).
`updated_at`	string	Timestamp of when the return group was last updated (default: `1970-01-01T00:00:00Z`).

ReturnSerializer

		Field Name Type Description
`id`	integer	Unique identifier for the return.
`status`	string	Status of the return. Possible values: REQUESTED REUPLOAD_REQUESTED CREATED SHIPMENT_CREATED LABEL_SENT SHIPPED DELIVERED UNTRACKED COMPLETED CANCELED
`product_platform_id`	string	Platform-specific ID for the product.
`product_name`	string	Name of the product.
`variant_platform_id`	string	Platform-specific ID for the product variant.
`variant_name`	string	Name of the product variant.
`line_item_platform_id`	string	Platform-specific ID for the line item.
`sku`	string (optional)	Stock keeping unit for the product.
`quantity`	integer	Quantity of the item being returned (default: 1).
`shipment_status`	string (optional)	Status of the shipment.
`carrier`	string (optional)	Carrier handling the shipment.
`tracking_number`	string (optional)	Tracking number for the shipment.
`return_reason_path`	string	Path to the return reason (e.g., category hierarchy).
`return_reason`	string	Reason for the return.
`return_note`	string	Additional notes for the return.
`return_subtotal`	MoneyBag	Subtotal for the return.
`return_discounted_subtotal`	MoneyBag	Discounted subtotal for the return.
`return_tax_total`	MoneyBag	Total tax for the return.
`return_total`	MoneyBag	Total amount for the return.
`created_at`	string	Timestamp of when the return was created (default: `1970-01-01T00:00:00Z`).
`updated_at`	string	Timestamp of when the return was last updated (default: `1970-01-01T00:00:00Z`).

MoneyBag

The MoneyBag type is used to represent monetary amounts in two contexts: shop currency and presentment currency.

		Field Name Type Description
`shop_money`	object	Contains `amount` (decimal) and `currency_code` (string) in the shop's currency.
`presentment_money`	object	Contains `amount` (decimal) and `currency_code` (string) in the presentment currency.

Example

{
  "shop_money": {
    "amount": 148.0,
    "currency_code": "USD"
  },
  "presentment_money": {
    "amount": 148.0,
    "currency_code": "USD"
  }
}

Example Return Group JSON

{
  "id": 1,
  "shop_name": "Example Shop",
  "order_platform_id": "ORD123",
  "order_name": "#12345",
  "order_created_at": "2025-01-01T12:00:00Z",
  "order_sales_channel": "Online",
  "customer_name": "John Doe",
  "customer_email": "johndoe@example.com",
  "country": "US",
  "shipment_status": "Delivered",
  "carrier": "UPS",
  "tracking_number": "1Z999AA10123456784",
  "return_method": "Mail",
  "credit_method": "Store Credit",
  "is_exchange": true,
  "is_instant_exchange": false,
  "return_subtotal": {
    "shop_money": {
      "amount": 100.00,
      "currency_code": "USD"
    },
    "presentment_money": {
      "amount": 100.00,
      "currency_code": "USD"
    }
  },
  "return_discounted_subtotal": {
    "shop_money": {
      "amount": 90.00,
      "currency_code": "USD"
    },
    "presentment_money": {
      "amount": 90.00,
      "currency_code": "USD"
    }
  },
  "return_tax_total": {
    "shop_money": {
      "amount": 10.00,
      "currency_code": "USD"
    },
    "presentment_money": {
      "amount": 10.00,
      "currency_code": "USD"
    }
  },
  "return_total": {
    "shop_money": {
      "amount": 100.00,
      "currency_code": "USD"
    },
    "presentment_money": {
      "amount": 100.00,
      "currency_code": "USD"
    }
  },
  "total_refunded": {
    "shop_money": {
      "amount": 50.00,
      "currency_code": "USD"
    },
    "presentment_money": {
      "amount": 50.00,
      "currency_code": "USD"
    }
  },
  "gift_card_order_ids": ["GFT123"],
  "returns": [
    {
      "id": 101,
      "status": "Pending",
      "product_platform_id": "PROD001",
      "product_name": "T-Shirt",
      "variant_platform_id": "VAR001",
      "variant_name": "Large / Blue",
      "line_item_platform_id": "LINE001",
      "sku": "SKU001",
      "quantity": 1,
      "return_reason_path": "Clothing > Defective",
      "return_reason": "Torn seam",
      "return_note": "Visible damage",
      "return_subtotal": {
        "shop_money": {
          "amount": 50.00,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 50.00,
          "currency_code": "USD"
        }
      },
      "return_discounted_subtotal": {
        "shop_money": {
          "amount": 45.00,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 45.00,
          "currency_code": "USD"
        }
      },
      "return_tax_total": {
        "shop_money": {
          "amount": 5.00,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 5.00,
          "currency_code": "USD"
        }
      },
      "return_total": {
        "shop_money": {
          "amount": 50.00,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 50.00,
          "currency_code": "USD"
        }
      },
      "created_at": "2025-01-01T12:00:00Z",
      "updated_at": "2025-01-01T12:30:00Z"
    }
  ],
  "created_at": "2025-01-01T12:00:00Z",
  "updated_at": "2025-01-01T12:30:00Z"
}