Skip to main content
POST
/
order
/
returns
Return order
curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/order/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant-key: <tenant-key>' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orderId": "62b37697c67b204dd18a7465",
  "returnTimeStamp": "2022-07-11T15:03:14.642Z",
  "employeeId": "8a7465",
  "source": "CSR",
  "items": [
    {
      "returnType": "RECEIVED",
      "orderLineItemId": "<string>",
      "shipmentId": "<string>",
      "shipmentLineId": "<string>",
      "quantity": 1,
      "scanTimeStamp": "2022-07-11T15:03:14.642Z",
      "reasonCode": "reasonCode",
      "subReasonCode": "subReasonCode",
      "policyOveride": true,
      "returnAmount": 100,
      "fees": [
        {
          "type": "tax",
          "value": 34.56,
          "quantity": 12,
          "refundAmount": 10.4
        }
      ]
    }
  ],
  "attributes": "\"attributes\": {\n     *     \"additionalProp1\": {},\n     *     \"additionalProp2\": {},\n     *     \"additionalProp3\": {}\n     *   }",
  "exchange": true
}
'
import requests

url = "https://prod01.oms.fabric.inc/api/v2/order/returns"

payload = {
    "orderId": "62b37697c67b204dd18a7465",
    "returnTimeStamp": "2022-07-11T15:03:14.642Z",
    "employeeId": "8a7465",
    "source": "CSR",
    "items": [
        {
            "returnType": "RECEIVED",
            "orderLineItemId": "<string>",
            "shipmentId": "<string>",
            "shipmentLineId": "<string>",
            "quantity": 1,
            "scanTimeStamp": "2022-07-11T15:03:14.642Z",
            "reasonCode": "reasonCode",
            "subReasonCode": "subReasonCode",
            "policyOveride": True,
            "returnAmount": 100,
            "fees": [
                {
                    "type": "tax",
                    "value": 34.56,
                    "quantity": 12,
                    "refundAmount": 10.4
                }
            ]
        }
    ],
    "attributes": "\"attributes\": {
     *     \"additionalProp1\": {},
     *     \"additionalProp2\": {},
     *     \"additionalProp3\": {}
     *   }",
    "exchange": True
}
headers = {
    "tenant-key": "<tenant-key>",
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'tenant-key': '<tenant-key>',
    'x-site-context': '<x-site-context>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    orderId: '62b37697c67b204dd18a7465',
    returnTimeStamp: '2022-07-11T15:03:14.642Z',
    employeeId: '8a7465',
    source: 'CSR',
    items: [
      {
        returnType: 'RECEIVED',
        orderLineItemId: '<string>',
        shipmentId: '<string>',
        shipmentLineId: '<string>',
        quantity: 1,
        scanTimeStamp: '2022-07-11T15:03:14.642Z',
        reasonCode: 'reasonCode',
        subReasonCode: 'subReasonCode',
        policyOveride: true,
        returnAmount: 100,
        fees: [{type: 'tax', value: 34.56, quantity: 12, refundAmount: 10.4}]
      }
    ],
    attributes: '"attributes": {\n     *     "additionalProp1": {},\n     *     "additionalProp2": {},\n     *     "additionalProp3": {}\n     *   }',
    exchange: true
  })
};

fetch('https://prod01.oms.fabric.inc/api/v2/order/returns', 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://prod01.oms.fabric.inc/api/v2/order/returns",
  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([
    'orderId' => '62b37697c67b204dd18a7465',
    'returnTimeStamp' => '2022-07-11T15:03:14.642Z',
    'employeeId' => '8a7465',
    'source' => 'CSR',
    'items' => [
        [
                'returnType' => 'RECEIVED',
                'orderLineItemId' => '<string>',
                'shipmentId' => '<string>',
                'shipmentLineId' => '<string>',
                'quantity' => 1,
                'scanTimeStamp' => '2022-07-11T15:03:14.642Z',
                'reasonCode' => 'reasonCode',
                'subReasonCode' => 'subReasonCode',
                'policyOveride' => true,
                'returnAmount' => 100,
                'fees' => [
                                [
                                                                'type' => 'tax',
                                                                'value' => 34.56,
                                                                'quantity' => 12,
                                                                'refundAmount' => 10.4
                                ]
                ]
        ]
    ],
    'attributes' => '"attributes": {
     *     "additionalProp1": {},
     *     "additionalProp2": {},
     *     "additionalProp3": {}
     *   }',
    'exchange' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "tenant-key: <tenant-key>",
    "x-site-context: <x-site-context>"
  ],
]);

$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://prod01.oms.fabric.inc/api/v2/order/returns"

	payload := strings.NewReader("{\n  \"orderId\": \"62b37697c67b204dd18a7465\",\n  \"returnTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n  \"employeeId\": \"8a7465\",\n  \"source\": \"CSR\",\n  \"items\": [\n    {\n      \"returnType\": \"RECEIVED\",\n      \"orderLineItemId\": \"<string>\",\n      \"shipmentId\": \"<string>\",\n      \"shipmentLineId\": \"<string>\",\n      \"quantity\": 1,\n      \"scanTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n      \"reasonCode\": \"reasonCode\",\n      \"subReasonCode\": \"subReasonCode\",\n      \"policyOveride\": true,\n      \"returnAmount\": 100,\n      \"fees\": [\n        {\n          \"type\": \"tax\",\n          \"value\": 34.56,\n          \"quantity\": 12,\n          \"refundAmount\": 10.4\n        }\n      ]\n    }\n  ],\n  \"attributes\": \"\\\"attributes\\\": {\\n     *     \\\"additionalProp1\\\": {},\\n     *     \\\"additionalProp2\\\": {},\\n     *     \\\"additionalProp3\\\": {}\\n     *   }\",\n  \"exchange\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("tenant-key", "<tenant-key>")
	req.Header.Add("x-site-context", "<x-site-context>")
	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://prod01.oms.fabric.inc/api/v2/order/returns")
  .header("tenant-key", "<tenant-key>")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderId\": \"62b37697c67b204dd18a7465\",\n  \"returnTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n  \"employeeId\": \"8a7465\",\n  \"source\": \"CSR\",\n  \"items\": [\n    {\n      \"returnType\": \"RECEIVED\",\n      \"orderLineItemId\": \"<string>\",\n      \"shipmentId\": \"<string>\",\n      \"shipmentLineId\": \"<string>\",\n      \"quantity\": 1,\n      \"scanTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n      \"reasonCode\": \"reasonCode\",\n      \"subReasonCode\": \"subReasonCode\",\n      \"policyOveride\": true,\n      \"returnAmount\": 100,\n      \"fees\": [\n        {\n          \"type\": \"tax\",\n          \"value\": 34.56,\n          \"quantity\": 12,\n          \"refundAmount\": 10.4\n        }\n      ]\n    }\n  ],\n  \"attributes\": \"\\\"attributes\\\": {\\n     *     \\\"additionalProp1\\\": {},\\n     *     \\\"additionalProp2\\\": {},\\n     *     \\\"additionalProp3\\\": {}\\n     *   }\",\n  \"exchange\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/order/returns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["tenant-key"] = '<tenant-key>'
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderId\": \"62b37697c67b204dd18a7465\",\n  \"returnTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n  \"employeeId\": \"8a7465\",\n  \"source\": \"CSR\",\n  \"items\": [\n    {\n      \"returnType\": \"RECEIVED\",\n      \"orderLineItemId\": \"<string>\",\n      \"shipmentId\": \"<string>\",\n      \"shipmentLineId\": \"<string>\",\n      \"quantity\": 1,\n      \"scanTimeStamp\": \"2022-07-11T15:03:14.642Z\",\n      \"reasonCode\": \"reasonCode\",\n      \"subReasonCode\": \"subReasonCode\",\n      \"policyOveride\": true,\n      \"returnAmount\": 100,\n      \"fees\": [\n        {\n          \"type\": \"tax\",\n          \"value\": 34.56,\n          \"quantity\": 12,\n          \"refundAmount\": 10.4\n        }\n      ]\n    }\n  ],\n  \"attributes\": \"\\\"attributes\\\": {\\n     *     \\\"additionalProp1\\\": {},\\n     *     \\\"additionalProp2\\\": {},\\n     *     \\\"additionalProp3\\\": {}\\n     *   }\",\n  \"exchange\": true\n}"

response = http.request(request)
puts response.read_body
{
  "totalRefund": 123,
  "items": [
    {
      "returnStatus": "VALID",
      "policyCode": "policyCode",
      "lineItemId": "32221112",
      "returnQuantity": 2,
      "refundAmount": 100
    }
  ]
}
{
  "message": "Bad Request"
}
{
  "message": "Order Not found"
}
{
  "message": "Internal Server Error"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
tenant-key
string
required
​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

ReturnOrder Model

​
orderId
string
required
Example:

"62b37697c67b204dd18a7465"

​
returnTimeStamp
string<date-time>
required
Example:

"2022-07-11T15:03:14.642Z"

​
employeeId
string
required
Example:

"8a7465"

​
source
string
required
Example:

"CSR"

​
items
object[]
required
​
attributes
object
Example:

"\"attributes\": {\n * \"additionalProp1\": {},\n * \"additionalProp2\": {},\n * \"additionalProp3\": {}\n * }"

​
exchange
boolean

Response

Return request accepted

ReturnOrderResponse Model

​
refundStatus
enum<string>
Available options:
REFUND_INITIATED,
REFUND_SUCCESS,
REFUND_FAILURE,
REFUND_PENDING
​
totalRefund
number
​
items
object[]