example-data.com
Menu
Browse docs and collections

Overview

shipments / #23

shipments #23

orderId
orders/43
carrier
usps
trackingNumber
CH47OAXFS3QJRR8S
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#23

#23

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 23,
  "orderId": 43,
  "carrier": "usps",
  "trackingNumber": "CH47OAXFS3QJRR8S",
  "status": "delivered",
  "shippedAt": "2024-11-09T08:53:53.947Z",
  "deliveredAt": "2024-11-11T17:43:32.952Z",
  "estimatedDeliveryAt": "2024-11-15T01:46:01.998Z",
  "createdAt": "2024-11-09T08:53:53.947Z"
}