Check order-exchange eligibility - Fabric

Check order-exchange eligibility

cURL

curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/order/exchange \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-key: <tenant-key>' \
  --header 'x-site-context: <x-site-context>'

Python

import requests

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

headers = {
    "tenant-key": "<tenant-key>",
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'GET',
  headers: {
    'tenant-key': '<tenant-key>',
    'x-site-context': '<x-site-context>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://prod01.oms.fabric.inc/api/v2/order/exchange', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://prod01.oms.fabric.inc/api/v2/order/exchange",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>",\
    "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;
}
?>

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("tenant-key", "<tenant-key>")
    req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://prod01.oms.fabric.inc/api/v2/order/exchange")
  .header("tenant-key", "<tenant-key>")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["tenant-key"] = '<tenant-key>'
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Responses

200

Application/json

Payload Example:

{
  "orderId": "62f3982438bcab1951be0a19",
  "eligibleReasonCodes": [
    "wrong item"
  ],
  "policyType": "Exchange or return or cancellation",
  "period": "30D00H00M",
  "items": [
    {
      "lineItemId": "62f3dfc438bcab1951be0a19",
      "eligibleQuantity": 10,
      "eligible": true
    }
  ],
  "fees": [
    {
      "platinumFee": 33.9,
      "currency": "USD"
    }
  ]
}

Error Responses:

400
```
{
  "message": "Bad request"
}
```

404

{
  "message": "Order with orderId is not found"
}

500

{
  "message": "Internal server error"
}

Authorizations

Authorization
- Type: string
- Location: header
- Required: Yes
- Format: Bearer <token>

Headers

tenant-key: (required)
x-site-context: (required)
- Contains information about the source to pull from, has attributes such as account, channel, stage, and date.
  - Example:
```
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
```

Query Parameters

orderId (required)
- Example:
```
"62f3982438bcab1951be0a19"
```
lineItemId
- Example:
```
"12345"
```

Response Structure

200
- orderId: Order ID
- eligibleReasonCodes: Array of reason codes for returns
- policyType: Type of policy
- period: Duration for returns
- items: List of items' eligibility
- fees: Associated fees