Releases order - Fabric

Releases order

cURL

curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/order/cross-border/release-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orderNumber": "<string>",
  "reasonCode": "<string>",
  "subReasonCode": "<string>",
  "note": "<string>"
}
'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/order/cross-border/release-order"

payload = {
    "orderNumber": "<string>",
    "reasonCode": "<string>",
    "subReasonCode": "<string>",
    "note": "<string>"
}
headers = {
    "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: {
    'x-site-context': '<x-site-context>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    orderNumber: '<string>',
    reasonCode: '<string>',
    subReasonCode: '<string>',
    note: '<string>'
  })
};

fetch('https://prod01.oms.fabric.inc/api/v2/order/cross-border/release-order', 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/cross-border/release-order",
  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([
    'orderNumber' => '<string>',
    'reasonCode' => '<string>',
    'subReasonCode' => '<string>',
    'note' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.oms.fabric.inc/api/v2/order/cross-border/release-order"

payload := strings.NewReader("{\n  \"orderNumber\": \"<string>\",\n  \"reasonCode\": \"<string>\",\n  \"subReasonCode\": \"<string>\",\n  \"note\": \"<string>\"\n}")

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

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/cross-border/release-order")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderNumber\": \"<string>\",\n  \"reasonCode\": \"<string>\",\n  \"subReasonCode\": \"<string>\",\n  \"note\": \"<string>\"}\n")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/order/cross-border/release-order")

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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderNumber\": \"<string>\",\n  \"reasonCode\": \"<string>\",\n  \"subReasonCode\": \"<string>\",\n  \"note\": \"<string>\"}\n"

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

Response Codes

400

404

500

{
  "message": "Order number is required"
}

{
  "message": "Order Not found"
}

{
  "message": "Internal Server Error"
}

Authorizations

Authorization
Type: string
Location: header
Required: Yes

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

Headers

x-site-context
Type: string
Required: Yes

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

CrossBorderReleaseOrderRequest Model
orderNumber
Type: string

releaseType
Type: enum<string>
Available options: RELEASE, CANCEL

reasonCode
Type: string

subReasonCode
Type: string

note
Type: string

Response

200 Success