API Documentation
Initial Redirect
3 min
to initiate a refund flow, merchants should redirect the customer to the refundid site using the following url structure https //portal refundid com/query order ?shop={{shop id}} \&email={{customer email}} \&order number={{order number}} \&key={{privacy key}} \&redirect={{redirect url}} query parameters query parameter is required description shop required a unique identifier assigned by refundid to the merchant email required email address of the customer order number required user readable order number merchant order ref optional system readable order id some e commerce systems differentiate between user readable order numbers and system readable order ids those systems may include this parameter key optional refundid also allows merchants to annotate the redirect with an optional privacy key if provided the key will be returned by refundid platform in all subsequent api interactions about that particular e commerce order merchant rma ref optional this is a special query param for merchants who manage the rma creation themselves for retailers using a custom integration, the order number and email field can be omitted in this instance the webhooks docid\ jcww2pr30h1sq6rxzi7cp webhook will be hit with the merchant rma ref (and key if provided) to fetch the order information parameter constraints shop , order number, merchant order ref, merchant rma ref, and key parameters can consist of arbitrary strings up to 255 characters in length these strings must not include spaces or non ascii characters if specified, email must be a valid email address and may be up to 320 characters in length examples https //portal refundid com/query order?order number=apidocs1234\&email=testemail\@gmail com https //portal refundid com/query order?shop=fivebyflynnn myshopify com note if all the required fields are included the form will auto submit
