Sync order status - Fabric

Sync order status

cURL

curl --request POST \
  --url https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orderId": "2947-5955-82579",
  "shipments": [
    {
      "shipmentCarrier": "FedEx",
      "trackingNumber": "2345367890876543",
      "lineItems": [
        {
          "lineItemId": 1,
          "quantity": 2
        }
      ],
      "shipmentStatus": "Delivered",
      "shipmentRef": "ref-1234",
      "shipmentCarrierUrl": "https://www.fedex.com/",
      "shippedDate": "2019-12-14",
      "estimatedDeliveryDate": "2019-12-14"
    }
  ]
}
'

Python

import requests

url = "https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status"

payload = {
    "orderId": "2947-5955-82579",
    "shipments": [
        {
            "shipmentCarrier": "FedEx",
            "trackingNumber": "2345367890876543",
            "lineItems": [
                {
                    "lineItemId": 1,
                    "quantity": 2
                }
            ],
            "shipmentStatus": "Delivered",
            "shipmentRef": "ref-1234",
            "shipmentCarrierUrl": "https://www.fedex.com/",
            "shippedDate": "2019-12-14",
            "estimatedDeliveryDate": "2019-12-14"
        }
    ]
}
headers = {
    "x-site-context": "<x-site-context>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch API)

const options = {
  method: 'POST',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orderId: '2947-5955-82579',
    shipments: [
      {
        shipmentCarrier: 'FedEx',
        trackingNumber: '2345367890876543',
        lineItems: [{lineItemId: 1, quantity: 2}],
        shipmentStatus: 'Delivered',
        shipmentRef: 'ref-1234',
        shipmentCarrierUrl: 'https://www.fedex.com/',
        shippedDate: '2019-12-14',
        estimatedDeliveryDate: '2019-12-14'
      }
    ]
  })
};

fetch('https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status', 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.yourcompany.fabric.zone/api-order/orders/pos/sync-status",
  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' => '2947-5955-82579',
    'shipments' => [
        [
                'shipmentCarrier' => 'FedEx',
                'trackingNumber' => '2345367890876543',
                'lineItems' => [
                                [
                                                                'lineItemId' => 1,
                                                                'quantity' => 2
                                ]
                ],
                'shipmentStatus' => 'Delivered',
                'shipmentRef' => 'ref-1234',
                'shipmentCarrierUrl' => 'https://www.fedex.com/',
                'shippedDate' => '2019-12-14',
                'estimatedDeliveryDate' => '2019-12-14'
        ]
    ]
  ]),
  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;
}

Go

package main

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

func main() {

url := "https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status"

payload := strings.NewReader(`{
  "orderId": "2947-5955-82579",
  "shipments": [
    {
      "shipmentCarrier": "FedEx",
      "trackingNumber": "2345367890876543",
      "lineItems": [
        {
          "lineItemId": 1,
          "quantity": 2
        }
      ],
      "shipmentStatus": "Delivered",
      "shipmentRef": "ref-1234",
      "shipmentCarrierUrl": "https://www.fedex.com/",
      "shippedDate": "2019-12-14",
      "estimatedDeliveryDate": "2019-12-14"
    }
  ]
}`)

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))
}

Java (Unirest)

HttpResponse<String> response = Unirest.post("https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body(`{
  "orderId": "2947-5955-82579",
  "shipments": [
    {
      "shipmentCarrier": "FedEx",
      "trackingNumber": "2345367890876543",
      "lineItems": [
        {
          "lineItemId": 1,
          "quantity": 2
        }
      ],
      "shipmentStatus": "Delivered",
      "shipmentRef": "ref-1234",
      "shipmentCarrierUrl": "https://www.fedex.com/",
      "shippedDate": "2019-12-14",
      "estimatedDeliveryDate": "2019-12-14"
    }
  ]
}`)
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/pos/sync-status")

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  \"orderId\": \"2947-5955-82579\",\n  \"shipments\": [\n    {\n      \"shipmentCarrier\": \"FedEx\",\n      \"trackingNumber\": \"2345367890876543\",\n      \"lineItems\": [\n        {\n          \"lineItemId\": 1,\n          \"quantity\": 2\n        }\n      ],\n      \"shipmentStatus\": \"Delivered\",\n      \"shipmentRef\": \"ref-1234\",\n      \"shipmentCarrierUrl\": \"https://www.fedex.com/\",\n      \"shippedDate\": \"2019-12-14\",\n      \"estimatedDeliveryDate\": \"2019-12-14\"\n    }\n  ]\n}"

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

Example Response

{
  "orderId": "2567-1064-60759",
  "status": "POS order status synced."
}

Headers

• x-api-key (string)

  • Example:
    • "0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

• x-site-context (string, required)

  • Description:
    • 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

• orderId (string, required)

  • Description:
    • Required string length: 15
  • Example:
    • "2947-5955-82579"

• shipments (object[])

  • Description:
    • Minimum array length: 1

Response

• 200 (application/json)
  • Description:
    • Successfully synced order
  • Attributes:
    • orderId (string)
      • Example:
        • "2567-1064-60759"
    • status (string)
      • Example:
        • "POS order status synced."