example-data.com
Menu
Browse docs and collections

Overview

shipments / #324

shipments #324

orderId
orders/614
carrier
ups
trackingNumber
IRC5T227DI857K8D
status
delivered
shippedAt
deliveredAt
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 324,
  "orderId": 614,
  "carrier": "ups",
  "trackingNumber": "IRC5T227DI857K8D",
  "status": "delivered",
  "shippedAt": "2024-11-12T02:24:04.735Z",
  "deliveredAt": "2024-11-19T00:36:48.668Z",
  "estimatedDeliveryAt": "2024-11-17T03:55:50.547Z",
  "createdAt": "2024-11-12T02:24:04.735Z"
}