Skip to main content
POST
/
shipments
/
actions
/
update-tracking
Update shipment tracking
curl --request POST \
  --url https://api.fabric.inc/v3/shipments/actions/update-tracking \
  --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 '
{
  "shipmentNumber": "78974156816152",
  "trackingNumber": "1Z999AA10123456784",
  "tracking": [
    {
      "event": "picked up",
      "eventId": "627963716b19511e8a3a631b",
      "eventRecordedAt": "2019-09-30T07:58:30.996Z",
      "location": "Reno, NV",
      "notes": {
        "description": "Shipment picked up"
      },
      "shipmentCarrier": "FEDEX"
    }
  ],
  "trackingURL": "https://example.com/tracking"
}
'
import requests

url = "https://api.fabric.inc/v3/shipments/actions/update-tracking"

payload = {
    "shipmentNumber": "78974156816152",
    "trackingNumber": "1Z999AA10123456784",
    "tracking": [
        {
            "event": "picked up",
            "eventId": "627963716b19511e8a3a631b",
            "eventRecordedAt": "2019-09-30T07:58:30.996Z",
            "location": "Reno, NV",
            "notes": { "description": "Shipment picked up" },
            "shipmentCarrier": "FEDEX"
        }
    ],
    "trackingURL": "https://example.com/tracking"
}
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)
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({
    shipmentNumber: '78974156816152',
    trackingNumber: '1Z999AA10123456784',
    tracking: [
      {
        event: 'picked up',
        eventId: '627963716b19511e8a3a631b',
        eventRecordedAt: '2019-09-30T07:58:30.996Z',
        location: 'Reno, NV',
        notes: {description: 'Shipment picked up'},
        shipmentCarrier: 'FEDEX'
      }
    ],
    trackingURL: 'https://example.com/tracking'
  })
};

fetch('https://api.fabric.inc/v3/shipments/actions/update-tracking', 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://api.fabric.inc/v3/shipments/actions/update-tracking",
  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([
    'shipmentNumber' => '78974156816152',
    'trackingNumber' => '1Z999AA10123456784',
    'tracking' => [
        [
                'event' => 'picked up',
                'eventId' => '627963716b19511e8a3a631b',
                'eventRecordedAt' => '2019-09-30T07:58:30.996Z',
                'location' => 'Reno, NV',
                'notes' => [
                                'description' => 'Shipment picked up'
                ],
                'shipmentCarrier' => 'FEDEX'
        ]
    ],
    'trackingURL' => 'https://example.com/tracking'
  ]),
  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;
}
package main

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

func main() {

	url := "https://api.fabric.inc/v3/shipments/actions/update-tracking"

	payload := strings.NewReader("{\n  \"shipmentNumber\": \"78974156816152\",\n  \"trackingNumber\": \"1Z999AA10123456784\",\n  \"tracking\": [\n    {\n      \"event\": \"picked up\",\n      \"eventId\": \"627963716b19511e8a3a631b\",\n      \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n      \"location\": \"Reno, NV\",\n      \"notes\": {\n        \"description\": \"Shipment picked up\"\n      },\n      \"shipmentCarrier\": \"FEDEX\"\n    }\n  ],\n  \"trackingURL\": \"https://example.com/tracking\"\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))

}
HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/shipments/actions/update-tracking")
  .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  \"shipmentNumber\": \"78974156816152\",\n  \"trackingNumber\": \"1Z999AA10123456784\",\n  \"tracking\": [\n    {\n      \"event\": \"picked up\",\n      \"eventId\": \"627963716b19511e8a3a631b\",\n      \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n      \"location\": \"Reno, NV\",\n      \"notes\": {\n        \"description\": \"Shipment picked up\"\n      },\n      \"shipmentCarrier\": \"FEDEX\"\n    }\n  ],\n  \"trackingURL\": \"https://example.com/tracking\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/shipments/actions/update-tracking")

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  \"shipmentNumber\": \"78974156816152\",\n  \"trackingNumber\": \"1Z999AA10123456784\",\n  \"tracking\": [\n    {\n      \"event\": \"picked up\",\n      \"eventId\": \"627963716b19511e8a3a631b\",\n      \"eventRecordedAt\": \"2019-09-30T07:58:30.996Z\",\n      \"location\": \"Reno, NV\",\n      \"notes\": {\n        \"description\": \"Shipment picked up\"\n      },\n      \"shipmentCarrier\": \"FEDEX\"\n    }\n  ],\n  \"trackingURL\": \"https://example.com/tracking\"\n}"

response = http.request(request)
puts response.read_body
{
  "shipments": [
    {
      "version": 2,
      "allocationId": "6413e3d3fd03a35efccb426e",
      "auditLogs": [
        {
          "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
          "auditType": "CANCEL",
          "auditedAt": "2023-03-12T09:24:54.804Z",
          "employeeId": "6227",
          "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
          "note": "Note",
          "reasonCode": "Scratched item",
          "source": "POS",
          "subReasonCode": "Scratched item",
          "updatedFields": [
            {
              "fieldName": "UOM",
              "fieldOriginalValue": "PK"
            }
          ]
        }
      ],
      "cartons": [
        {
          "cartonNumber": "1",
          "cartonType": "Package",
          "estimatedDeliveryDate": "2023-04-26T07:58:30.996Z",
          "estimatedShipmentDate": "2023-03-25T07:58:30.996Z",
          "items": [
            {
              "fees": [
                {
                  "amount": 34.56,
                  "amountInCurrencies": [
                    {
                      "currency": "USD",
                      "group": "SHOPPER",
                      "amount": 123.45
                    }
                  ],
                  "name": "RETURN_FEE",
                  "reason": "Return fee",
                  "type": "FEE"
                }
              ],
              "giftCards": [
                {
                  "amount": 50,
                  "amountInCurrencies": [
                    {
                      "currency": "USD",
                      "group": "SHOPPER",
                      "amount": 123.45
                    }
                  ],
                  "giftCardActivatedAt": "2023-04-26T07:58:30.996Z",
                  "giftCardActivationRequestedAt": "2023-03-26T07:58:30.996Z",
                  "giftCardNumber": "453456765",
                  "giftCardStatus": "ACTIVE"
                }
              ],
              "itemId": 100023,
              "lineItemId": "1",
              "orderId": "6413e370cb0dc859b6c0dcb0",
              "orderNumber": "309020213",
              "orderedQuantity": 2,
              "refundAmount": 10,
              "refundAmountInCurrencies": [
                {
                  "currency": "USD",
                  "group": "SHOPPER",
                  "amount": 123.45
                }
              ],
              "returnQuantity": 1,
              "segment": "segment",
              "shipmentLineItemId": "607f1f77bcf86cd799439011",
              "shippedQuantity": 2,
              "sku": "SKU0023",
              "uom": "EA",
              "vendorId": "vend12346667"
            }
          ],
          "promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
          "shipmentCarrier": "FEDEX",
          "shipmentMethod": "ground",
          "tracking": [
            {
              "event": "picked up",
              "eventId": "627963716b19511e8a3a631b",
              "eventRecordedAt": "2019-09-30T07:58:30.996Z",
              "location": "Reno, NV",
              "notes": {
                "description": "Shipment picked up"
              },
              "shipmentCarrier": "FEDEX"
            }
          ],
          "trackingNumber": "1Z999AA10123456784",
          "trackingURL": "https://example.com/tracking",
          "weight": "500 grams"
        }
      ],
      "createdAt": "2023-04-06T07:58:30.996Z",
      "invoiceId": "63ef4360aafa8a7f5247fe48",
      "locationNumber": "WH334",
      "locationType": "DC",
      "masterTrackingNumber": "TX112345678",
      "orderNumbers": [
        "309020213, 459020213"
      ],
      "poNumber": "1125",
      "recipients": [
        {
          "email": "support@example.inc",
          "name": {
            "firstName": "Alex",
            "lastName": "Doe",
            "middleName": "E"
          },
          "phone": {
            "number": "123-456-7890",
            "type": "MOBILE"
          }
        }
      ],
      "reshipmentReasonCode": "Order is missing",
      "scratchedItems": [
        {
          "reasonCode": "ReasonCode23454",
          "itemId": 100043,
          "lineItemId": "2",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "quantity": 1,
          "sku": "SKU00043",
          "subReasonCode": "SubReasonCode23242",
          "uom": "EA"
        }
      ],
      "shipToAddress": {
        "addressLine1": "123 Main St.",
        "city": "Seattle",
        "countryCode": "US",
        "latitude": 47.6205,
        "longitude": -122.3493,
        "postalCode": "98121",
        "region": "WA",
        "type": "Home",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "email": "test@example.com",
        "name": {
          "firstName": "Alex",
          "lastName": "Doe",
          "middleName": "E"
        },
        "phone": {
          "number": "123-456-7890",
          "type": "MOBILE"
        }
      },
      "shipToId": "1",
      "shipmentId": "627963716b19511e8a3a631b",
      "shipmentNumber": "78974156816152",
      "shipmentExternalId": "123k4h123k",
      "shippedAt": "2023-04-06T07:58:30.996Z",
      "statusCode": "SHIPMENT_CREATED",
      "subtype": "COD",
      "totalCartons": 2,
      "type": "STANDARD",
      "updatedAt": "2023-04-06T07:58:30.996Z",
      "vendorId": "56"
    }
  ]
}
{
  "errors": [
    {
      "message": "Invalid request",
      "type": "CLIENT_ERROR"
    }
  ],
  "message": "Bad request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Unauthorized request",
  "type": "CLIENT_ERROR"
}
{
  "message": "Shipment not found",
  "type": "CLIENT_ERROR"
}
{
  "message": "Internal server error",
  "type": "SERVER_ERROR"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

​
x-fabric-request-id
string

Unique request ID

Body

application/json

Shipment tracking details

​
shipmentNumber
string
required

Merchant-defined unique shipment identifier

Example:

"78974156816152"

​
trackingNumber
string
required

Tracking number

Example:

"1Z999AA10123456784"

​
tracking
object[]

Tracking details

​
trackingURL
string

Tracking URL

Example:

"https://example.com/tracking"

Response

OK

Shipment response

​
shipments
object[]

Shipment details