Search for answers to common problems and get support from our team.

Support Menu

Contact Support

ReturnGroupSerializer V1

ReturnGroupSerializer

 Field Name TypeDescription
idintegerUnique identifier for the return group.
shop_namestringName of the associated shop.
order_platform_idstringPlatform-specific ID for the order.
order_namestringDisplay name for the order.
order_created_atstringTimestamp of when the order was created.
order_sales_channelstringSales channel associated with the order.
customer_namestringName of the customer.
customer_emailstringEmail address of the customer.
countrystringCountry of the customer.
shipment_statusstring (optional)Status of the shipment.
carrierstring (optional)Carrier handling the shipment.
tracking_numberstring (optional)Tracking number for the shipment.
return_methodstringMethod of return (e.g., mail, in-store).
credit_methodstringCredit method used (e.g., refund, store credit).
is_exchangebooleanIndicates whether the return is an exchange.
is_instant_exchangebooleanIndicates whether the exchange is instant.
return_subtotalMoneyBagSubtotal for the return.
return_discounted_subtotalMoneyBagDiscounted subtotal for the return.
return_tax_totalMoneyBagTotal tax for the return.
return_totalMoneyBagTotal amount for the return.
total_refundedMoneyBagTotal amount refunded.
gift_card_order_idslist of stringsList of order IDs associated with gift cards.
returnslist of ReturnSerializerList of return items included in this group.
created_atstringTimestamp of when the return group was created (default: 1970-01-01T00:00:00Z).
updated_atstringTimestamp of when the return group was last updated (default: 1970-01-01T00:00:00Z).

ReturnSerializer

  Field Name Type Description
idintegerUnique identifier for the return.
statusstring

Status of the return. Possible values:

  1. REQUESTED
  2. REUPLOAD_REQUESTED
  3. CREATED
  4. SHIPMENT_CREATED
  5. LABEL_SENT
  6. SHIPPED
  7. DELIVERED
  8. UNTRACKED
  9. COMPLETED
  10. CANCELED
product_platform_idstringPlatform-specific ID for the product.
product_namestringName of the product.
variant_platform_idstringPlatform-specific ID for the product variant.
variant_namestringName of the product variant.
line_item_platform_idstringPlatform-specific ID for the line item.
skustring (optional)Stock keeping unit for the product.
quantityintegerQuantity of the item being returned (default: 1).
shipment_statusstring (optional)Status of the shipment.
carrierstring (optional)Carrier handling the shipment.
tracking_numberstring (optional)Tracking number for the shipment.
return_reason_pathstringPath to the return reason (e.g., category hierarchy).
return_reasonstringReason for the return.
return_notestringAdditional notes for the return.
return_subtotalMoneyBagSubtotal for the return.
return_discounted_subtotalMoneyBagDiscounted subtotal for the return.
return_tax_totalMoneyBagTotal tax for the return.
return_totalMoneyBagTotal amount for the return.
created_atstringTimestamp of when the return was created (default: 1970-01-01T00:00:00Z).
updated_atstringTimestamp 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_moneyobjectContains amount (decimal) and currency_code (string) in the shop's currency.
presentment_moneyobjectContains 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"
}

 

Related Links