Order return by order number
curl --request POST \
--url https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"items": [
{
"orderLineItemId": "1",
"quantity": 1,
"returnType": "RECEIVED",
"scannedAt": "2022-07-11T15:03:14.642Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineId": "12",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isPolicyOverride": true,
"reasonCode": "Incorrect order",
"refundAmount": 21.5,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"subReasonCode": "Incorrect specification"
}
],
"source": "CSR",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"credits": [
{
"amount": 21.5,
"currency": "USD",
"reasonCode": "EC",
"source": "CSR",
"type": "GIFT_CARD",
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"attributes": {
"giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"employeeId": "12312232",
"note": "Credit request initiated",
"paymentCounter": 1,
"policyCode": "RC1",
"subReasonCode": "ACC"
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isExchange": false,
"reasonCode": "Incorrect item",
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnedAt": "2022-07-11T15:03:14.642Z",
"totalRefundAmount": 21.5,
"requestContext": {
"id": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"type": "<string>",
"requestTime": "2022-04-12T09:30:31.198Z",
"attributes": {
"attribute": "N",
"someFlag": true
}
}
}
'import requests
url = "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request"
payload = {
"items": [
{
"orderLineItemId": "1",
"quantity": 1,
"returnType": "RECEIVED",
"scannedAt": "2022-07-11T15:03:14.642Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineId": "12",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isPolicyOverride": True,
"reasonCode": "Incorrect order",
"refundAmount": 21.5,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"subReasonCode": "Incorrect specification"
}
],
"source": "CSR",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"credits": [
{
"amount": 21.5,
"currency": "USD",
"reasonCode": "EC",
"source": "CSR",
"type": "GIFT_CARD",
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"attributes": { "giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ" },
"employeeId": "12312232",
"note": "Credit request initiated",
"paymentCounter": 1,
"policyCode": "RC1",
"subReasonCode": "ACC"
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isExchange": False,
"reasonCode": "Incorrect item",
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnedAt": "2022-07-11T15:03:14.642Z",
"totalRefundAmount": 21.5,
"requestContext": {
"id": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"type": "<string>",
"requestTime": "2022-04-12T09:30:31.198Z",
"attributes": {
"attribute": "N",
"someFlag": True
}
}
}
headers = {
"x-fabric-tenant-id": "<x-fabric-tenant-id>",
"x-fabric-channel-id": "<x-fabric-channel-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-fabric-tenant-id': '<x-fabric-tenant-id>',
'x-fabric-channel-id': '<x-fabric-channel-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
orderLineItemId: '1',
quantity: 1,
returnType: 'RECEIVED',
scannedAt: '2022-07-11T15:03:14.642Z',
shipmentId: '62b37697c67b204dd18a7465',
shipmentLineId: '12',
attributes: {
fraudCheckSessionId: '59f1d2b88de74aef96d3ec900ad548e0',
fraudStatus: 'FRAUD_PASS'
},
fees: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
isPolicyOverride: true,
reasonCode: 'Incorrect order',
refundAmount: 21.5,
refundAmountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
refunds: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
returnAmountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
subReasonCode: 'Incorrect specification'
}
],
source: 'CSR',
attributes: {
fraudCheckSessionId: '59f1d2b88de74aef96d3ec900ad548e0',
fraudStatus: 'FRAUD_PASS'
},
credits: [
{
amount: 21.5,
currency: 'USD',
reasonCode: 'EC',
source: 'CSR',
type: 'GIFT_CARD',
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
attributes: {giftCardNumber: 'XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ'},
employeeId: '12312232',
note: 'Credit request initiated',
paymentCounter: 1,
policyCode: 'RC1',
subReasonCode: 'ACC'
}
],
employeeId: '62272e917b12209e68751d94',
fees: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
isExchange: false,
reasonCode: 'Incorrect item',
refunds: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
returnedAt: '2022-07-11T15:03:14.642Z',
totalRefundAmount: 21.5,
requestContext: {
id: 'a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111',
type: '<string>',
requestTime: '2022-04-12T09:30:31.198Z',
attributes: {attribute: 'N', someFlag: true}
}
})
};
fetch('https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'orderLineItemId' => '1',
'quantity' => 1,
'returnType' => 'RECEIVED',
'scannedAt' => '2022-07-11T15:03:14.642Z',
'shipmentId' => '62b37697c67b204dd18a7465',
'shipmentLineId' => '12',
'attributes' => [
'fraudCheckSessionId' => '59f1d2b88de74aef96d3ec900ad548e0',
'fraudStatus' => 'FRAUD_PASS'
],
'fees' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'isPolicyOverride' => true,
'reasonCode' => 'Incorrect order',
'refundAmount' => 21.5,
'refundAmountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'refunds' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'returnAmountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'subReasonCode' => 'Incorrect specification'
]
],
'source' => 'CSR',
'attributes' => [
'fraudCheckSessionId' => '59f1d2b88de74aef96d3ec900ad548e0',
'fraudStatus' => 'FRAUD_PASS'
],
'credits' => [
[
'amount' => 21.5,
'currency' => 'USD',
'reasonCode' => 'EC',
'source' => 'CSR',
'type' => 'GIFT_CARD',
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'attributes' => [
'giftCardNumber' => 'XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ'
],
'employeeId' => '12312232',
'note' => 'Credit request initiated',
'paymentCounter' => 1,
'policyCode' => 'RC1',
'subReasonCode' => 'ACC'
]
],
'employeeId' => '62272e917b12209e68751d94',
'fees' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'isExchange' => false,
'reasonCode' => 'Incorrect item',
'refunds' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'returnedAt' => '2022-07-11T15:03:14.642Z',
'totalRefundAmount' => 21.5,
'requestContext' => [
'id' => 'a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111',
'type' => '<string>',
'requestTime' => '2022-04-12T09:30:31.198Z',
'attributes' => [
'attribute' => 'N',
'someFlag' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-fabric-channel-id: <x-fabric-channel-id>",
"x-fabric-tenant-id: <x-fabric-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request"
payload := strings.NewReader("{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request")
.header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
.header("x-fabric-channel-id", "<x-fabric-channel-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"lineItemId": "62f3dfc438bcab1951be0a19",
"policyCode": "policyCode",
"refundAmount": 21.5,
"returnQuantity": 2,
"returnStatus": "VALID"
}
],
"refundStatus": "REFUND_INITIATED",
"totalRefundAmount": 21.5,
"totalRefundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
]
}{
"errors": [
{
"message": "Invalid request",
"type": "CLIENT_ERROR"
}
],
"message": "Bad request",
"type": "CLIENT_ERROR"
}{
"message": "Unauthorized request",
"type": "CLIENT_ERROR"
}"{\"message\": \"Order not found, \"type\":\"CLIENT_ERROR\"\" }"{
"message": "Internal server error",
"type": "SERVER_ERROR"
}Returns
Order return by order number
When the customers return request is determined to be eligible, this endpoint is used to process the return request.
Note: If you do not have the order number, but have order ID, use Return order by order ID endpoint - POST /orders/{orderId}/actions/submit-return-request.
POST
/
orders
/
order-number
/
{orderNumber}
/
actions
/
submit-return-request
Order return by order number
curl --request POST \
--url https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"items": [
{
"orderLineItemId": "1",
"quantity": 1,
"returnType": "RECEIVED",
"scannedAt": "2022-07-11T15:03:14.642Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineId": "12",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isPolicyOverride": true,
"reasonCode": "Incorrect order",
"refundAmount": 21.5,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"subReasonCode": "Incorrect specification"
}
],
"source": "CSR",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"credits": [
{
"amount": 21.5,
"currency": "USD",
"reasonCode": "EC",
"source": "CSR",
"type": "GIFT_CARD",
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"attributes": {
"giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"employeeId": "12312232",
"note": "Credit request initiated",
"paymentCounter": 1,
"policyCode": "RC1",
"subReasonCode": "ACC"
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isExchange": false,
"reasonCode": "Incorrect item",
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnedAt": "2022-07-11T15:03:14.642Z",
"totalRefundAmount": 21.5,
"requestContext": {
"id": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"type": "<string>",
"requestTime": "2022-04-12T09:30:31.198Z",
"attributes": {
"attribute": "N",
"someFlag": true
}
}
}
'import requests
url = "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request"
payload = {
"items": [
{
"orderLineItemId": "1",
"quantity": 1,
"returnType": "RECEIVED",
"scannedAt": "2022-07-11T15:03:14.642Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineId": "12",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isPolicyOverride": True,
"reasonCode": "Incorrect order",
"refundAmount": 21.5,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"subReasonCode": "Incorrect specification"
}
],
"source": "CSR",
"attributes": {
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
},
"credits": [
{
"amount": 21.5,
"currency": "USD",
"reasonCode": "EC",
"source": "CSR",
"type": "GIFT_CARD",
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"attributes": { "giftCardNumber": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ" },
"employeeId": "12312232",
"note": "Credit request initiated",
"paymentCounter": 1,
"policyCode": "RC1",
"subReasonCode": "ACC"
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"isExchange": False,
"reasonCode": "Incorrect item",
"refunds": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnedAt": "2022-07-11T15:03:14.642Z",
"totalRefundAmount": 21.5,
"requestContext": {
"id": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"type": "<string>",
"requestTime": "2022-04-12T09:30:31.198Z",
"attributes": {
"attribute": "N",
"someFlag": True
}
}
}
headers = {
"x-fabric-tenant-id": "<x-fabric-tenant-id>",
"x-fabric-channel-id": "<x-fabric-channel-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-fabric-tenant-id': '<x-fabric-tenant-id>',
'x-fabric-channel-id': '<x-fabric-channel-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
orderLineItemId: '1',
quantity: 1,
returnType: 'RECEIVED',
scannedAt: '2022-07-11T15:03:14.642Z',
shipmentId: '62b37697c67b204dd18a7465',
shipmentLineId: '12',
attributes: {
fraudCheckSessionId: '59f1d2b88de74aef96d3ec900ad548e0',
fraudStatus: 'FRAUD_PASS'
},
fees: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
isPolicyOverride: true,
reasonCode: 'Incorrect order',
refundAmount: 21.5,
refundAmountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
refunds: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
returnAmountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
subReasonCode: 'Incorrect specification'
}
],
source: 'CSR',
attributes: {
fraudCheckSessionId: '59f1d2b88de74aef96d3ec900ad548e0',
fraudStatus: 'FRAUD_PASS'
},
credits: [
{
amount: 21.5,
currency: 'USD',
reasonCode: 'EC',
source: 'CSR',
type: 'GIFT_CARD',
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
attributes: {giftCardNumber: 'XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ'},
employeeId: '12312232',
note: 'Credit request initiated',
paymentCounter: 1,
policyCode: 'RC1',
subReasonCode: 'ACC'
}
],
employeeId: '62272e917b12209e68751d94',
fees: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
isExchange: false,
reasonCode: 'Incorrect item',
refunds: [
{
amount: 34.56,
amountInCurrencies: [{currency: 'USD', group: 'SHOPPER', amount: 123.45}],
name: 'RETURN_FEE',
reason: 'Return fee',
type: 'FEE'
}
],
returnedAt: '2022-07-11T15:03:14.642Z',
totalRefundAmount: 21.5,
requestContext: {
id: 'a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111',
type: '<string>',
requestTime: '2022-04-12T09:30:31.198Z',
attributes: {attribute: 'N', someFlag: true}
}
})
};
fetch('https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'orderLineItemId' => '1',
'quantity' => 1,
'returnType' => 'RECEIVED',
'scannedAt' => '2022-07-11T15:03:14.642Z',
'shipmentId' => '62b37697c67b204dd18a7465',
'shipmentLineId' => '12',
'attributes' => [
'fraudCheckSessionId' => '59f1d2b88de74aef96d3ec900ad548e0',
'fraudStatus' => 'FRAUD_PASS'
],
'fees' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'isPolicyOverride' => true,
'reasonCode' => 'Incorrect order',
'refundAmount' => 21.5,
'refundAmountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'refunds' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'returnAmountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'subReasonCode' => 'Incorrect specification'
]
],
'source' => 'CSR',
'attributes' => [
'fraudCheckSessionId' => '59f1d2b88de74aef96d3ec900ad548e0',
'fraudStatus' => 'FRAUD_PASS'
],
'credits' => [
[
'amount' => 21.5,
'currency' => 'USD',
'reasonCode' => 'EC',
'source' => 'CSR',
'type' => 'GIFT_CARD',
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'attributes' => [
'giftCardNumber' => 'XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ'
],
'employeeId' => '12312232',
'note' => 'Credit request initiated',
'paymentCounter' => 1,
'policyCode' => 'RC1',
'subReasonCode' => 'ACC'
]
],
'employeeId' => '62272e917b12209e68751d94',
'fees' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'isExchange' => false,
'reasonCode' => 'Incorrect item',
'refunds' => [
[
'amount' => 34.56,
'amountInCurrencies' => [
[
'currency' => 'USD',
'group' => 'SHOPPER',
'amount' => 123.45
]
],
'name' => 'RETURN_FEE',
'reason' => 'Return fee',
'type' => 'FEE'
]
],
'returnedAt' => '2022-07-11T15:03:14.642Z',
'totalRefundAmount' => 21.5,
'requestContext' => [
'id' => 'a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111',
'type' => '<string>',
'requestTime' => '2022-04-12T09:30:31.198Z',
'attributes' => [
'attribute' => 'N',
'someFlag' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-fabric-channel-id: <x-fabric-channel-id>",
"x-fabric-tenant-id: <x-fabric-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request"
payload := strings.NewReader("{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request")
.header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
.header("x-fabric-channel-id", "<x-fabric-channel-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/submit-return-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"orderLineItemId\": \"1\",\n \"quantity\": 1,\n \"returnType\": \"RECEIVED\",\n \"scannedAt\": \"2022-07-11T15:03:14.642Z\",\n \"shipmentId\": \"62b37697c67b204dd18a7465\",\n \"shipmentLineId\": \"12\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isPolicyOverride\": true,\n \"reasonCode\": \"Incorrect order\",\n \"refundAmount\": 21.5,\n \"refundAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnAmountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"subReasonCode\": \"Incorrect specification\"\n }\n ],\n \"source\": \"CSR\",\n \"attributes\": {\n \"fraudCheckSessionId\": \"59f1d2b88de74aef96d3ec900ad548e0\",\n \"fraudStatus\": \"FRAUD_PASS\"\n },\n \"credits\": [\n {\n \"amount\": 21.5,\n \"currency\": \"USD\",\n \"reasonCode\": \"EC\",\n \"source\": \"CSR\",\n \"type\": \"GIFT_CARD\",\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"attributes\": {\n \"giftCardNumber\": \"XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ\"\n },\n \"employeeId\": \"12312232\",\n \"note\": \"Credit request initiated\",\n \"paymentCounter\": 1,\n \"policyCode\": \"RC1\",\n \"subReasonCode\": \"ACC\"\n }\n ],\n \"employeeId\": \"62272e917b12209e68751d94\",\n \"fees\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"isExchange\": false,\n \"reasonCode\": \"Incorrect item\",\n \"refunds\": [\n {\n \"amount\": 34.56,\n \"amountInCurrencies\": [\n {\n \"currency\": \"USD\",\n \"group\": \"SHOPPER\",\n \"amount\": 123.45\n }\n ],\n \"name\": \"RETURN_FEE\",\n \"reason\": \"Return fee\",\n \"type\": \"FEE\"\n }\n ],\n \"returnedAt\": \"2022-07-11T15:03:14.642Z\",\n \"totalRefundAmount\": 21.5,\n \"requestContext\": {\n \"id\": \"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111\",\n \"type\": \"<string>\",\n \"requestTime\": \"2022-04-12T09:30:31.198Z\",\n \"attributes\": {\n \"attribute\": \"N\",\n \"someFlag\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"lineItemId": "62f3dfc438bcab1951be0a19",
"policyCode": "policyCode",
"refundAmount": 21.5,
"returnQuantity": 2,
"returnStatus": "VALID"
}
],
"refundStatus": "REFUND_INITIATED",
"totalRefundAmount": 21.5,
"totalRefundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
]
}{
"errors": [
{
"message": "Invalid request",
"type": "CLIENT_ERROR"
}
],
"message": "Bad request",
"type": "CLIENT_ERROR"
}{
"message": "Unauthorized request",
"type": "CLIENT_ERROR"
}"{\"message\": \"Order not found, \"type\":\"CLIENT_ERROR\"\" }"{
"message": "Internal server error",
"type": "SERVER_ERROR"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
Merchant-defined order identifier
Body
application/json
Return request
Item details
Show child attributes
Show child attributes
Merchant-defined source from where the return request was initiated. There are no pre-defined values; possible values are Customer Service Representative (CSR), point-of-sale (POS), etc.
Example:
"CSR"
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Example:
{
"fraudCheckSessionId": "59f1d2b88de74aef96d3ec900ad548e0",
"fraudStatus": "FRAUD_PASS"
}
Show child attributes
Show child attributes
Employee (ID or name) who initiated the request
Example:
"62272e917b12209e68751d94"
Show child attributes
Show child attributes
true: Return includes one or more exchanges. false: Only returns, no exchange.
Example:
false
Merchant-defined reason code for return
Example:
"Incorrect item"
Show child attributes
Show child attributes
Merchant-defined time for return (UTC)
Example:
"2022-07-11T15:03:14.642Z"
Merchant-defined total refund amount
Example:
21.5
Request reference context information
Show child attributes
Show child attributes
Response
Return request accepted
An object containing the details of a returned order.
Item details
Show child attributes
Show child attributes
Refund status
Available options:
REFUND_INITIATED, REFUND_SUCCESS, REFUND_FAILURE, REFUND_PENDING Example:
"REFUND_INITIATED"
Merchant-defined total refund amount
Example:
21.5
Show child attributes
Show child attributes
Was this page helpful?