example-data.com
Menu
Browse docs and collections

Overview

shipments / #54

shipments #54

orderId
orders/97
carrier
fedex
trackingNumber
04IFN39YETJ056FJ
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#54

#54

Related

References

Request

curl example 

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

JavaScript example 

const res = await fetch(
  "https://example-data.com/api/v1/shipments/54"
);
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/54"
);
const shipment = (await res.json()) as Shipment;

Python example 

import requests

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

Response 

{
  "id": 54,
  "orderId": 97,
  "carrier": "fedex",
  "trackingNumber": "04IFN39YETJ056FJ",
  "status": "delivered",
  "shippedAt": "2024-12-18T02:28:56.375Z",
  "deliveredAt": "2024-12-20T21:40:58.099Z",
  "estimatedDeliveryAt": "2024-12-27T15:43:07.373Z",
  "createdAt": "2024-12-18T02:28:56.375Z"
}