Acknowledge shipment - Fabric

Acknowledge Shipment

cURL

curl --request POST \
  --url https://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "acknowledgedAt": "2023-08-01T20:03:28.483971941Z",
  "attributes": {
    "shipmentId": "627963716b19511e8a3a631b"
  }
}
'

Python

import requests

url = "https://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge"

payload = {
    "acknowledgedAt": "2023-08-01T20:03:28.483971941Z",
    "attributes": { "shipmentId": "627963716b19511e8a3a631b" }
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "x-fabric-channel-id": "<x-fabric-channel-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    'x-fabric-channel-id': '<x-fabric-channel-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    acknowledgedAt: '2023-08-01T20:03:28.483971941Z',
    attributes: {shipmentId: '627963716b19511e8a3a631b'}
  })
};

fetch('https://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge', 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://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge",
  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([
    'acknowledgedAt' => '2023-08-01T20:03:28.483971941Z',
    'attributes' => [
        'shipmentId' => '627963716b19511e8a3a631b'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-channel-id: <x-fabric-channel-id>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$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://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge"

payload := strings.NewReader("{\n  \"acknowledgedAt\": \"2023-08-01T20:03:28.483971941Z\",\n  \"attributes\": {\n    \"shipmentId\": \"627963716b19511e8a3a631b\"\n  }\n}")

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

req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
    req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
    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))
}

Unirest (Java)

HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("x-fabric-channel-id", "<x-fabric-channel-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"acknowledgedAt\": \"2023-08-01T20:03:28.483971941Z\",\n  \"attributes\": {\n    \"shipmentId\": \"627963716b19511e8a3a631b\"\n  }\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/shipments/{shipmentId}/acknowledge")

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

request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"acknowledgedAt\": \"2023-08-01T20:03:28.483971941Z\",\n  \"attributes\": {\n    \"shipmentId\": \"627963716b19511e8a3a631b\"\n  }\n}"

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

Response Status Codes

Example Response

Successful Acknowledgment

{
  "acknowledgedAt": "2023-02-01T20:03:28.483971941Z"
}

Client Error

{
  "errors": [
    {
      "message": "Invalid request",
      "type": "CLIENT_ERROR"
    }
  ],
  "message": "Bad request",
  "type": "CLIENT_ERROR"
}

Unauthorized Error

{
  "message": "Unauthorized request",
  "type": "CLIENT_ERROR"
}

Not Found Error

{
  "message": "Shipment not found",
  "type": "CLIENT_ERROR"
}

Server Error

{
  "message": "Internal server error",
  "type": "SERVER_ERROR"
}

Authorizations

Authorization
Type: string (header) required Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Path Parameters

Body