example-data.com
Menu
Browse docs and collections

Overview

shipments / #238

shipments #238

orderId
orders/456
carrier
ups
trackingNumber
J2RUQQ3I60E1PHF3
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 238,
  "orderId": 456,
  "carrier": "ups",
  "trackingNumber": "J2RUQQ3I60E1PHF3",
  "status": "delivered",
  "shippedAt": "2024-07-16T17:32:00.364Z",
  "deliveredAt": "2024-07-23T08:43:13.042Z",
  "estimatedDeliveryAt": "2024-07-25T14:26:34.117Z",
  "createdAt": "2024-07-16T17:32:00.364Z"
}