example-data.com
Menu
Browse docs and collections

Overview

shipments / #289

shipments #289

orderId
orders/543
carrier
fedex
trackingNumber
28UQ2VFSC51HSMPI
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

curl -sS \
  "https://example-data.com/api/v1/shipments/289" \
  -H "Accept: application/json"

JavaScript example 

const res = await fetch(
  "https://example-data.com/api/v1/shipments/289"
);
const shipment = await res.json();

TypeScript example 

// Download once: mkdir -p types && curl -o types/shipments.d.ts https://example-data.com/types/shipments.d.ts
import type { Shipment } from "./types/shipments";

const res = await fetch(
  "https://example-data.com/api/v1/shipments/289"
);
const shipment = (await res.json()) as Shipment;

Python example 

import requests

res = requests.get(
    "https://example-data.com/api/v1/shipments/289"
)
shipment = res.json()

Response 

{
  "id": 289,
  "orderId": 543,
  "carrier": "fedex",
  "trackingNumber": "28UQ2VFSC51HSMPI",
  "status": "delivered",
  "shippedAt": "2024-07-08T01:30:45.076Z",
  "deliveredAt": "2024-07-16T00:20:30.114Z",
  "estimatedDeliveryAt": "2024-07-15T03:33:44.014Z",
  "createdAt": "2024-07-08T01:30:45.076Z"
}