example-data.com
Menu
Browse docs and collections

Overview

shipments / #333

shipments #333

orderId
orders/627
carrier
dhl
trackingNumber
B751Z9U8U1MBTBTW
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 333,
  "orderId": 627,
  "carrier": "dhl",
  "trackingNumber": "B751Z9U8U1MBTBTW",
  "status": "delivered",
  "shippedAt": "2024-09-21T14:16:16.051Z",
  "deliveredAt": "2024-09-27T15:59:12.399Z",
  "estimatedDeliveryAt": "2024-09-23T20:07:12.943Z",
  "createdAt": "2024-09-21T14:16:16.051Z"
}