example-data.com
Menu
Browse docs and collections

Overview

shipments / #38

shipments #38

orderId
orders/71
carrier
ups
trackingNumber
HVUIGQVQGC43C7GY
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Medium

#38

#38

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 38,
  "orderId": 71,
  "carrier": "ups",
  "trackingNumber": "HVUIGQVQGC43C7GY",
  "status": "delivered",
  "shippedAt": "2024-09-14T13:00:58.978Z",
  "deliveredAt": "2024-09-18T21:50:19.463Z",
  "estimatedDeliveryAt": "2024-09-21T10:16:28.002Z",
  "createdAt": "2024-09-14T13:00:58.978Z"
}