Loop Returns · Example Payload

Loop Returns Return Example

ReturnsE-CommerceExchangesRefundsShippingPost-PurchaseShopifyFraud PreventionRetail

Loop Returns Return Example is an example object payload from Loop Returns, with 35 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idstateoutcomeorder_idorder_nameprovider_order_idcustomercurrencytotalrefundhandling_feereturn_product_totalreturn_discount_totalreturn_tax_totalreturn_totalreturn_credit_totalexchange_product_totalexchange_discount_totalexchange_tax_totalexchange_totalexchange_credit_totalgift_cardgift_card_order_namegift_card_order_idcarriertracking_numberlabel_statuslabel_urllabel_ratedestination_idstatus_page_urlreturn_methodcreated_atupdated_atedited_at

Example Payload

{
  "id": "12345678",
  "state": "open",
  "outcome": "exchange",
  "order_id": "98766312",
  "order_name": "#7382018",
  "provider_order_id": "3248923479283",
  "customer": "customer@example.com",
  "currency": "USD",
  "total": "63.30",
  "refund": "0.00",
  "handling_fee": "0.00",
  "return_product_total": "156.00",
  "return_discount_total": "0.00",
  "return_tax_total": "8.58",
  "return_total": "164.58",
  "return_credit_total": "101.28",
  "exchange_product_total": "96.00",
  "exchange_discount_total": "0.00",
  "exchange_tax_total": "5.28",
  "exchange_total": "101.28",
  "exchange_credit_total": "101.28",
  "gift_card": "0.00",
  "gift_card_order_name": null,
  "gift_card_order_id": null,
  "carrier": "USPS",
  "tracking_number": "9400136105440512280610",
  "label_status": "in_transit",
  "label_url": "https://s3.amazonaws.com/example-bucket/label.pdf",
  "label_rate": "4.50",
  "destination_id": "67896541368765",
  "status_page_url": "https://example.loopreturns.com/#/return/example-uuid",
  "return_method": "prepaid_label",
  "created_at": "2023-01-01T22:27:15.000Z",
  "updated_at": "2023-01-01T22:27:18.000Z",
  "edited_at": "2023-01-03T22:34:17.000Z"
}