Bulk return orders
curl --request POST \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '
[
{
"returnCode": "123",
"orderId": "2947-5955-82579",
"returnMessage": "Customer not interested",
"sugarRefund": true
}
]
'import requests
url = "https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return"
payload = [
{
"returnCode": "123",
"orderId": "2947-5955-82579",
"returnMessage": "Customer not interested",
"sugarRefund": True
}
]
headers = {
"x-site-context": "<x-site-context>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
returnCode: '123',
orderId: '2947-5955-82579',
returnMessage: 'Customer not interested',
sugarRefund: true
}
])
};
fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return', 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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return",
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([
[
'returnCode' => '123',
'orderId' => '2947-5955-82579',
'returnMessage' => 'Customer not interested',
'sugarRefund' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return"
payload := strings.NewReader("[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return")
.header("x-site-context", "<x-site-context>")
.header("Content-Type", "application/json")
.body("[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]"
response = http.request(request)
puts response.read_body[
{
"orderId": "4719-4940-97474",
"status": "Error",
"code": "ORDER_RETURN_INVALID",
"message": "Order status must be ORDER_SHIPPED or ORDER_FULFILLED or ORDER_DELIVERD"
},
{
"orderId": "7579-4892-68436",
"status": "Successfully Returned order"
}
]{
"code": "<string>",
"message": "<string>"
}{
"message": "Forbidden"
}{
"code": "<string>",
"message": "<string>"
}Order
Bulk return orders
Bulk return orders
POST
/
api-order
/
orders
/
bulk-return
Bulk return orders
curl --request POST \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '
[
{
"returnCode": "123",
"orderId": "2947-5955-82579",
"returnMessage": "Customer not interested",
"sugarRefund": true
}
]
'import requests
url = "https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return"
payload = [
{
"returnCode": "123",
"orderId": "2947-5955-82579",
"returnMessage": "Customer not interested",
"sugarRefund": True
}
]
headers = {
"x-site-context": "<x-site-context>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
returnCode: '123',
orderId: '2947-5955-82579',
returnMessage: 'Customer not interested',
sugarRefund: true
}
])
};
fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return', 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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return",
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([
[
'returnCode' => '123',
'orderId' => '2947-5955-82579',
'returnMessage' => 'Customer not interested',
'sugarRefund' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return"
payload := strings.NewReader("[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
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-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return")
.header("x-site-context", "<x-site-context>")
.header("Content-Type", "application/json")
.body("[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/bulk-return")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"returnCode\": \"123\",\n \"orderId\": \"2947-5955-82579\",\n \"returnMessage\": \"Customer not interested\",\n \"sugarRefund\": true\n }\n]"
response = http.request(request)
puts response.read_body[
{
"orderId": "4719-4940-97474",
"status": "Error",
"code": "ORDER_RETURN_INVALID",
"message": "Order status must be ORDER_SHIPPED or ORDER_FULFILLED or ORDER_DELIVERD"
},
{
"orderId": "7579-4892-68436",
"status": "Successfully Returned order"
}
]{
"code": "<string>",
"message": "<string>"
}{
"message": "Forbidden"
}{
"code": "<string>",
"message": "<string>"
}Headers
Example:
"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"
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
Response
Successfully return orders
Was this page helpful?
⌘I
