Refundid Provided APIs

refundid provides a set of apis that may be optionally invoked by the merchant's e commerce system to query and/or update the current state of refundid "return merchant authorizations" (referred to as rmas throughout the doc) merchants are not required to use these apis, as all of the necessary functionality is readily available to all merchants through the refundid merchant portal however, these apis are particularly useful for merchants who wish to integrate some or all of the refund processing functionality available through the refundid merchant portal directly into their existing returns processing system authentication and security refundid provided apis implement a layered security model similar to the one supported for merchant provided apis this allows merchants to choose from a range of authentication methods to ensure the authenticity of refundid api requests, aligning seamlessly with their unique e commerce platform architectures api key all requests to refundid provided apis must be submitted with a refundid api key, issued to the merchant by refundid this key is used to identify the merchant in the api request, and therefore is required for all requests the api key header has the following form "x refundid api key" {{merchant api key}} the api key is generated by refundid and will consist of up to 256 arbitrary printable (i e , non whitespace) ascii characters if you require an api key generated for a particular environment please reach out to integrations\@refundid com { "name" "get returns", "method" "get", "url" "https //api refundid com/v1/merchant/returns", "description" "searches the refundid system for existing refundid rmas, either active or historic and matching the specified search criteria \n\nresponse object \nrefunds list of rapirefundidorder | rapistandardreturn objects these objects contain details regarding each return \noffset an integer representing the copy of the offset request parameter typically used in paginated responses to denote the starting point of the data in the current page \nmore a boolean indicating if there are any more records available after the current page \n", "tab" "examples", "examples" { "languages" \[ { "id" "n2bqdkear5gho5kgohfio", "language" "curl", "code" "curl location request get 'https //api refundid com/v1/merchant/returns?date from=2022 02 12+00%3a00%3a00\&date to=2022 02 15+00%3a00%3a00\&return statuses=approved%2crejected%2ccancelled\&resolutions=instant%2cstore credit%2cgift card\&order by=rma id \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'\n header 'x refundid api key' {{merchant api key}} ", "customlabel" "" } ], "selectedlanguageid" "n2bqdkear5gho5kgohfio" }, "results" { "languages" \[ { "id" "wqouc5hrjhg03tku9wc x", "language" "200", "customlabel" "", "code" "{\n \\"returns\\" \[\n {\n \\"standard return id\\" \\"3\\",\n \\"return resolution\\" \\"store credit\\",\n \\"status\\" \\"closed\\",\n \\"requested refund breakdown\\" {\n \\"subtotal\\" {\n \\"amount\\" 140,\n \\"currency\\" \\"aud\\"\n },\n \\"store return fee\\" {\n \\"amount\\" 3 33,\n \\"currency\\" \\"aud\\"\n },\n \\"customer shipping cost\\" {\n \\"amount\\" 0,\n \\"currency\\" \\"aud\\"\n },\n \\"total\\" {\n \\"amount\\" 136 67,\n \\"currency\\" \\"aud\\"\n }\n },\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"id 3\\",\n \\"line item ref\\" \\"ref 3\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 3\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n },\n {\n \\"merchant order ref\\" \\"id 2\\",\n \\"line item ref\\" \\"ref 2\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 2\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n },\n {\n \\"merchant order ref\\" \\"id 1\\",\n \\"line item ref\\" \\"ref 1\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 1\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ],\n \\"rma ref\\" \\"rma6\\",\n \\"order number\\" \\"on 6\\",\n \\"shipping label\\" {\n \\"tracking\\" {\n \\"carrier\\" \\"australia post\\",\n \\"tracking number\\" \\"123123\\",\n \\"status\\" \\"transit\\",\n \\"status date\\" \\"2022 02 14t00 00 00z\\"\n },\n \\"purchase price\\" null,\n \\"label url\\" null\n },\n \\"close breakdown\\" {\n \\"final refund amount\\" {\n \\"amount\\" 140,\n \\"currency\\" \\"aud\\"\n },\n \\"closed on\\" \\"2022 02 13t00 00 00\\",\n \\"closed by\\" \\"merchant\\",\n \\"refunds\\" \[]\n }\n },\n {\n \\"standard return id\\" \\"2\\",\n \\"return resolution\\" \\"gift card\\",\n \\"status\\" \\"closed\\",\n \\"requested refund breakdown\\" {\n \\"subtotal\\" {\n \\"amount\\" 20,\n \\"currency\\" \\"aud\\"\n },\n \\"store return fee\\" {\n \\"amount\\" 2 7,\n \\"currency\\" \\"aud\\"\n },\n \\"customer shipping cost\\" {\n \\"amount\\" 0,\n \\"currency\\" \\"aud\\"\n },\n \\"total\\" {\n \\"amount\\" 17 3,\n \\"currency\\" \\"aud\\"\n }\n },\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"id 1\\",\n \\"line item ref\\" \\"ref 1\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"some reason\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ],\n \\"rma ref\\" \\"rma5\\",\n \\"order number\\" \\"on 5\\",\n \\"shipping label\\" {\n \\"tracking\\" {\n \\"carrier\\" \\"australia post\\",\n \\"tracking number\\" \\"123123\\",\n \\"status\\" \\"transit\\",\n \\"status date\\" \\"2022 02 14t00 00 00z\\"\n },\n \\"purchase price\\" null,\n \\"label url\\" null\n },\n \\"close breakdown\\" {\n \\"final refund amount\\" {\n \\"amount\\" 20,\n \\"currency\\" \\"aud\\"\n },\n \\"closed on\\" \\"2022 02 13t00 00 00\\",\n \\"closed by\\" \\"merchant\\",\n \\"refunds\\" \[]\n }\n },\n {\n \\"refundid id\\" \\"3\\",\n \\"rma ref\\" \\"rma3\\",\n \\"order number\\" \\"on 3\\",\n \\"merchant rma ref\\" \\"rma 2\\",\n \\"status\\" \\"closed\\",\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"id 3\\",\n \\"line item ref\\" \\"ref 3\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 3\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n },\n {\n \\"merchant order ref\\" \\"id 2\\",\n \\"line item ref\\" \\"ref 2\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 2\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n },\n {\n \\"merchant order ref\\" \\"id 1\\",\n \\"line item ref\\" \\"ref 1\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"reason 1\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ],\n \\"refund breakdown\\" {\n \\"subtotal\\" {\n \\"amount\\" 140,\n \\"currency\\" \\"aud\\"\n },\n \\"store return fee\\" {\n \\"amount\\" 3 33,\n \\"currency\\" \\"aud\\"\n },\n \\"customer shipping cost\\" {\n \\"amount\\" 0,\n \\"currency\\" \\"aud\\"\n },\n \\"total\\" {\n \\"amount\\" 136 67,\n \\"currency\\" \\"aud\\"\n }\n },\n \\"shipping label\\" {\n \\"tracking\\" {\n \\"carrier\\" \\"australia post\\",\n \\"tracking number\\" \\"123123\\",\n \\"status\\" \\"transit\\",\n \\"status date\\" \\"2022 02 15t00 00 00z\\"\n },\n \\"purchase price\\" null,\n \\"label url\\" null\n },\n \\"reconciliation breakdown\\" {\n \\"discounted amount to reconcile from merchant\\" 0,\n \\"amount to reconcile from merchant\\" 0,\n \\"shipping to reconcile from merchant\\" 0,\n \\"merchant advance adjustment\\" 0,\n \\"refundid cut\\" 0,\n \\"discounted refundid cut\\" 0,\n \\"invoice created at\\" null,\n \\"closed by\\" \\"merchant\\"\n }\n },\n {\n \\"refundid id\\" \\"2\\",\n \\"rma ref\\" \\"rma2\\",\n \\"order number\\" \\"on 2\\",\n \\"merchant rma ref\\" \\"rma 2\\",\n \\"status\\" \\"closed\\",\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"id 1\\",\n \\"line item ref\\" \\"ref 1\\",\n \\"quantity\\" 1,\n \\"return reason\\" \\"some reason\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\",\n \\"type\\" \\"text\\"\n }\n ],\n \\"sku\\" null,\n \\"child return reason\\" null,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ],\n \\"refund breakdown\\" {\n \\"subtotal\\" {\n \\"amount\\" 20,\n \\"currency\\" \\"aud\\"\n },\n \\"store return fee\\" {\n \\"amount\\" 2 7,\n \\"currency\\" \\"aud\\"\n },\n \\"customer shipping cost\\" {\n \\"amount\\" 0,\n \\"currency\\" \\"aud\\"\n },\n \\"total\\" {\n \\"amount\\" 17 3,\n \\"currency\\" \\"aud\\"\n }\n },\n \\"shipping label\\" {\n \\"tracking\\" {\n \\"carrier\\" \\"australia post\\",\n \\"tracking number\\" \\"123123\\",\n \\"status\\" \\"transit\\",\n \\"status date\\" \\"2022 02 14t00 00 00z\\"\n },\n \\"purchase price\\" null,\n \\"label url\\" null\n },\n \\"reconciliation breakdown\\" {\n \\"discounted amount to reconcile from merchant\\" 0,\n \\"amount to reconcile from merchant\\" 0,\n \\"shipping to reconcile from merchant\\" 0,\n \\"merchant advance adjustment\\" 0,\n \\"refundid cut\\" 0,\n \\"discounted refundid cut\\" 0,\n \\"invoice created at\\" null,\n \\"closed by\\" \\"merchant\\"\n }\n }\n ],\n \\"offset\\" 0,\n \\"more\\" false\n}" } ], "selectedlanguageid" "wqouc5hrjhg03tku9wc x" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "return statuses", "kind" "optional", "type" "string", "description" "comma seperated list containing the following \napproved, rejected, cancelled, pending, invoiced, double refunded, multi outcome\n\nif left empty include all ", "children" \[] }, { "name" "tracking statuses", "kind" "optional", "type" "string", "description" "comma seperated list of refundidtrackingstatus values", "children" \[] }, { "name" "resolutions", "kind" "optional", "type" "string", "description" "comma seperated list of values either\ninstant, instant exchange or the internal name of a standard resolution", "children" \[] }, { "name" "date from", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas creation date", "children" \[] }, { "name" "date to", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas created date", "children" \[] }, { "name" "limit", "kind" "optional", "type" "integer", "description" "restricts the result to at most limit records; if more records match the specified search criteria, the result will include a \\"more=true\\" flag and the remaining records may be retrieved by specifying a suitable offset value if specified, must be a positive integer", "children" \[] }, { "name" "offset", "kind" "optional", "type" "number", "description" "begins the search after the first offset records matching the requested search critiera if specified, must be a non negative integer ", "children" \[] }, { "name" "query", "kind" "optional", "type" "string", "description" "used to search through the following fields\nexact match on \n customer first name\n customer last name\n customer mobile\n customer email\n customer full name\n rma id\n refundid order id\n tracking number\n\ncontains search on \n order number", "children" \[] }, { "name" "order by", "kind" "optional", "type" "string", "description" "can be one of the following \nrma id, email, created date, item number, amount, lost in transit date, delivered date, refund status, tracking status, resolution", "children" \[] }, { "name" "is desc", "kind" "optional", "type" "boolean", "description" "whether the ordering should be done in descending order (defaults to true if omitted)", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "get refunds (deprecated please use get returns instead)", "method" "get", "url" "https //api refundid com/v1/merchant/refunds", "description" "searches the refundid system for existing refundid rmas, either active or historic and matching the specified search criteria \n\nresponse object \nrefunds list of rapirefundidorder objects these objects contain details regarding each refund \noffset an integer representing the copy of the offset request parameter typically used in paginated responses to denote the starting point of the data in the current page \nmore a boolean indicating if there are any more records available after the current page \ntotal an integer (or none) representing the total number of records available this attribute is present if the include total parameter was requested \n", "tab" "examples", "examples" { "languages" \[ { "id" "n2bqdkear5gho5kgohfio", "language" "curl", "code" "curl location request get 'https //api refundid com/v1/merchant/refunds?status=open\&start date=20220215\&end date=20220215' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'\n header 'x refundid api key' {{merchant api key}} ", "customlabel" "" } ], "selectedlanguageid" "n2bqdkear5gho5kgohfio" }, "results" { "languages" \[ { "id" "wqouc5hrjhg03tku9wc x", "language" "200", "customlabel" "", "code" "{\n \\"refunds\\" \[\n {\n \\"refundid id\\" \\"4\\",\n \\"status\\" \\"refundid\\",\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"id 1\\",\n \\"line item ref\\" \\"ref 1\\",\n \\"quantity\\" 2,\n \\"return reason\\" \\"some reason\\",\n \\"return reason notes\\" \[\n {\n \\"title\\" \\"title\\",\n \\"value\\" \\"value\\"\n }\n ],\n \\"restock\\" false\n }\n ],\n \\"refund breakdown\\" {\n \\"subtotal\\" {\n \\"amount\\" 20,\n \\"currency\\" \\"aud\\"\n },\n \\"store return fee\\" {\n \\"amount\\" 2 7,\n \\"currency\\" \\"aud\\"\n },\n \\"customer shipping cost\\" {\n \\"amount\\" 0,\n \\"currency\\" \\"aud\\"\n },\n \\"total\\" {\n \\"amount\\" 17 3,\n \\"currency\\" \\"aud\\"\n }\n },\n \\"shipping label\\" {\n \\"tracking\\" {\n \\"carrier\\" \\"australia post\\",\n \\"tracking number\\" \\"123123\\",\n \\"status\\" \\"transit\\",\n \\"status date\\" \\"2022 02 16t00 00 00+00 00\\"\n }\n }\n }\n ],\n \\"offset\\" 0,\n \\"more\\" false\n}" } ], "selectedlanguageid" "wqouc5hrjhg03tku9wc x" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "status", "kind" "required", "type" "string", "description" "open | closed | invoiced", "children" \[] }, { "name" "refund id", "kind" "optional", "type" "string", "description" "comma seperated refund ids", "children" \[] }, { "name" "merchant order ref", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas for the specified merchant generated order id", "children" \[] }, { "name" "merchant rma ref", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas for the specified merchant generated rma ids", "children" \[] }, { "name" "order number", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas for the specified merchant generated order numbers", "children" \[] }, { "name" "email", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas associated with the specified customer emails", "children" \[] }, { "name" "start date", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas created (if status=\\"open\\") or closed (if status=\\"closed\\") on or after the specified start date", "children" \[] }, { "name" "end date", "kind" "optional", "type" "string", "description" "restricts the results to refundid rmas created (if status=\\"open\\") or closed (if status=\\"closed\\") on or before the specified end date", "children" \[] }, { "name" "limit", "kind" "optional", "type" "integer", "description" "restricts the result to at most limit records; if more records match the specified search criteria, the result will include a \\"more=true\\" flag and the remaining records may be retrieved by specifying a suitable offset value if specified, must be a positive integer", "children" \[] }, { "name" "offset", "kind" "optional", "type" "number", "description" "begins the search after the first offset records matching the requested search critiera if specified, must be a non negative integer ", "children" \[] }, { "name" "include total", "kind" "optional", "type" "boolean", "description" "includes in the result a total number of records matching the specified search criteria, ignoring the limit and offset values", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "name" "post tracking", "method" "post", "url" "https //api refundid com/v1/merchant/tracking", "description" "this api may be used by merchant to provide refundid with merchant purchased shipping labels to be used by customer to return the refunded goods to the merchant \n\nit should be used only by merchants who purchase the shipping labels themselves without refundid's involvement \n\nrefundid always requires a shipping label to be attached to every refund request before it can be approved by the merchant, and usually requires customers to a valid enter tracking number for an rma on the refundid dashboard within three days of receiving a refund however, if the merchant generates the shipping label themselves, they can streamline the process for their customer by providing refundid with these labels directly as soon as they have been generated and communicated to the customer \n\nwhen providing a shipping label, merchant can identify the rma either by refundid generated \\"refundid id\\" or by the merchant generated \\"merchant rma id\\" at least one of these fields must be provided, and, if both are provided, they must be consistent with each other each shipping label must include at least the \\"tracking\\" information, and should include the \\"purchase price\\", which is cross checked by refundid with the previously calculated purchase price used to determine the refund amount owed to the customer ", "tab" "examples", "examples" { "languages" \[ { "id" "yp1w5wysbkkyiw7ywedsh", "language" "curl", "code" "curl location 'https //api refundid com/v1/merchant/tracking' \\\\\n header 'content type application/json' \\\\\n header 'x refundid api key' {{merchant api key}} \\\\\n data '\[\n {\n \\"refundid id\\" 123,\n \\"tracking\\" {\\"carrier\\" \\"some carrier\\", \\"tracking number\\" \\"tk12345\\"},\n },\n {\n \\"refundid id\\" 124,\n \\"tracking\\" {\\"carrier\\" \\"some other carrier\\", \\"tracking number\\" \\"tk87654\\"},\n },\n]'", "customlabel" "" } ], "selectedlanguageid" "yp1w5wysbkkyiw7ywedsh" }, "results" { "languages" \[ { "id" "3ovdpgsqsnxnph9xf8qul", "language" "201", "customlabel" "", "code" "\[\n {\n \\"tracking\\" {\n \\"tracking info id\\" 1,\n \\"carrier\\" \\"some carrier\\",\n \\"tracking number\\" \\"tk12345\\",\n \\"tracking status\\" null,\n \\"tracking status date\\" null,\n \\"reused\\" false,\n \\"lost in transit\\" false,\n \\"orders using same tracking\\" \[]\n },\n \\"shipping label\\" null\n },\n {\n \\"tracking\\" {\n \\"tracking info id\\" 2,\n \\"carrier\\" \\"some other carrier\\",\n \\"tracking number\\" \\"tk87654\\",\n \\"tracking status\\" null,\n \\"tracking status date\\" null,\n \\"reused\\" false,\n \\"lost in transit\\" false,\n \\"orders using same tracking\\" \[]\n },\n \\"shipping label\\" null\n }\n]" }, { "id" "qohcefbzd3j1uy5mkwu4m", "language" "400", "customlabel" "", "code" "{\\"error\\" \\"duplicate tracking infos provided \[('tk12345', 'some carrier')]\\"}" } ], "selectedlanguageid" "3ovdpgsqsnxnph9xf8qul" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "", "kind" "required", "type" "array", "description" "list of rapirefundidordertracking" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "close refund", "method" "post", "url" "https //api refundid com/v1/merchant/close refunds", "description" "merchants who wish to finalise (approve or reject) refundid rmas through their existing returns processing system should use this api to notify refundid of the final resolution of every rma refunded through the refundid platform \n\nmerchants who prefer to use the refundid merchant portal to finalise refundid rmas do not need to use this api, but will still be notified of the outcome if they implement the \\"post /refundid\\" webhook \n\nwhen using the \\"/v1/merchant/close refunds\\" api, merchants should provide the resolution of one or more refundid rmas in a json object of the structure described below \n\nin the request body, each refundid rma can be identified either by the refundid generated \\"refundid id\\", \\"standard return id\\" or a merchant generated \\"merchant rma ref\\" each line item in the rma should be identified by merchant generated \\"merchant order ref\\", a \\"line item ref\\", and a \\"quantity\\" \n\na given line item may be repeated more than once if different resolution is required for different quantities of the underlying merchandise \n\nfor each item, merchant must provide one of the predefined resolution codes if approving an item, they should also provide a \\"restock\\" flag, indicating whether the item is being restocked or not ", "tab" "examples", "examples" { "languages" \[ { "id" "qdsx0dgenesmdgmt5qpfe", "language" "curl", "code" "curl location 'https //api refundid com/v1/merchant/close refunds' \\\\\n header 'content type application/json' \\\\\n header 'x refundid api key' {{merchant api key}} \\\\\n data '\[\n {\n \\"refundid id\\" \\"100\\",\n \\"merchant rma ref\\" null,\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"123\\",\n \\"line item ref\\" \\"1\\",\n \\"quantity\\" 1,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ]\n },\n {\n \\"refundid id\\" \\"1\\",\n \\"merchant rma ref\\" null,\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"123\\",\n \\"line item ref\\" \\"1\\",\n \\"quantity\\" 1,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ]\n },\n {\n \\"standard return id\\" \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\",\n \\"merchant rma ref\\" null,\n \\"line items\\" \[\n {\n \\"merchant order ref\\" \\"123\\",\n \\"line item ref\\" \\"1\\",\n \\"quantity\\" 1,\n \\"resolution\\" \\"accept\\",\n \\"restock\\" false,\n \\"notes\\" null\n }\n ]\n }\n]'", "customlabel" "" } ], "selectedlanguageid" "qdsx0dgenesmdgmt5qpfe" }, "results" { "languages" \[ { "id" "roypkwb2zxcsmeyznusjj", "language" "200", "code" "{\n \\"1\\" \\"refund 1 does not exist\\", \n \\"100\\" \\"success\\",\n \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\" \\"success\\"\n}", "customlabel" "" }, { "id" "dugfcuh5i qwl7kvitp2q", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "customlabel" "" } ], "selectedlanguageid" "roypkwb2zxcsmeyznusjj" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "parameter name", "kind" "required", "type" "string", "description" "list of rapicloserefundidorder or rapiclosestandardreturn", "" "required" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "add return note", "method" "post", "url" "https //api refundid com/v1/merchant/note", "description" "this endpoint can be used to add an additional note to the refundid rma the note can be viewed in the refundid merchant portal ", "tab" "examples", "examples" { "languages" \[ { "id" "qdsx0dgenesmdgmt5qpfe", "language" "curl", "code" "curl location 'https //api refundid com/v1/merchant/note' \\\\\n header 'content type application/json' \\\\\n header 'x refundid api key' {{merchant api key}} \\\\\n data '\[\n {\n \\"refundid id\\" \\"1\\",\n \\"note\\" \\"hello world!\\"\n },\n {\n \\"standard return id\\" \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\",\n \\"note\\" \\"hello world!\\"\n }\n]'", "customlabel" "" } ], "selectedlanguageid" "qdsx0dgenesmdgmt5qpfe" }, "results" { "languages" \[ { "id" "roypkwb2zxcsmeyznusjj", "language" "200", "code" "\[\n \\"1\\" {\n \\"message\\" \\"refund 1 does not exist\\",\n },\n \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\" {\n \\"message\\" \\"success\\",\n }\n]", "customlabel" "" }, { "id" "dugfcuh5i qwl7kvitp2q", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "customlabel" "" } ], "selectedlanguageid" "roypkwb2zxcsmeyznusjj" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "parameter name", "kind" "required", "type" "array", "description" "list of rapireturnnote", "" "list of rapireturnnote" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "name" "flag return", "method" "put", "url" "https //api refundid com/v1/merchant/flag", "description" "this endpoint flags a return for the merchant portal", "tab" "examples", "examples" { "languages" \[ { "id" "qdsx0dgenesmdgmt5qpfe", "language" "curl", "code" "curl location 'https //api refundid com/v1/merchant/flag' \\\\\n header 'content type application/json' \\\\\n header 'x refundid api key' {{merchant api key}} \\\\\n data '\[\n {\n \\"refundid id\\" \\"1\\",\n \\"is flagged\\" false\n },\n {\n \\"standard return id\\" \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\",\n \\"is flagged\\" true\n }\n]'", "customlabel" "" } ], "selectedlanguageid" "qdsx0dgenesmdgmt5qpfe" }, "results" { "languages" \[ { "id" "roypkwb2zxcsmeyznusjj", "language" "200", "code" "{\n \\"1\\" {\n \\"message\\" \\"refund 1 does not exist\\",\n },\n \\"gaaaaabmhp ybgcgr 38v8cbhoswij5aliskh2apouen715xvbubc1chdfsnfnnu0vt bszfcxm0x0s5rl ovjccl7b6g lj9g==\\" {\n \\"message\\" \\"success\\",\n \\"is flagged\\" true\n }\n}", "customlabel" "" }, { "id" "dugfcuh5i qwl7kvitp2q", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }", "customlabel" "" } ], "selectedlanguageid" "roypkwb2zxcsmeyznusjj" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "parameter name", "kind" "required", "type" "array", "description" "list of rapireturnflag", "" "list of rapireturnflag" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }