example-data.com
Menu
Browse docs and collections

Overview

shipments / #272

shipments #272

orderId
orders/514
carrier
ups
trackingNumber
IDF1YTUXFS8N17EC
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 272,
  "orderId": 514,
  "carrier": "ups",
  "trackingNumber": "IDF1YTUXFS8N17EC",
  "status": "delivered",
  "shippedAt": "2024-09-29T18:57:03.986Z",
  "deliveredAt": "2024-10-02T18:30:51.516Z",
  "estimatedDeliveryAt": "2024-10-07T11:39:49.019Z",
  "createdAt": "2024-09-29T18:57:03.986Z"
}