example-data.com
Menu
Browse docs and collections

Overview

shipments / #16

shipments #16

orderId
orders/24
carrier
fedex
trackingNumber
P828L1WK9NLJ1YLD
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example

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

JavaScript example

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

Python example

import requests

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

Response

{
  "id": 16,
  "orderId": 24,
  "carrier": "fedex",
  "trackingNumber": "P828L1WK9NLJ1YLD",
  "status": "delivered",
  "shippedAt": "2024-11-02T01:21:14.789Z",
  "deliveredAt": "2024-11-09T15:18:53.932Z",
  "estimatedDeliveryAt": "2024-11-06T14:43:51.947Z",
  "createdAt": "2024-11-02T01:21:14.789Z"
}