example-data.com
Menu
Browse docs and collections

Overview

shipments / #314

shipments #314

orderId
orders/596
carrier
usps
trackingNumber
N4F7NCCC2P5AKB12
status
in_transit
shippedAt
deliveredAt
—
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 314,
  "orderId": 596,
  "carrier": "usps",
  "trackingNumber": "N4F7NCCC2P5AKB12",
  "status": "in_transit",
  "shippedAt": "2024-08-06T17:06:29.232Z",
  "deliveredAt": null,
  "estimatedDeliveryAt": "2024-08-09T12:22:43.814Z",
  "createdAt": "2024-08-06T17:06:29.232Z"
}