example-data.com
Menu
Browse docs and collections

Overview

shipments / #387

shipments #387

orderId
orders/722
carrier
fedex
trackingNumber
PYP7LC1UMWZOM0HE
status
in_transit
shippedAt
deliveredAt
—
estimatedDeliveryAt
createdAt

Component variants

Related

References

Request

curl example 

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

JavaScript example 

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

Python example 

import requests

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

Response 

{
  "id": 387,
  "orderId": 722,
  "carrier": "fedex",
  "trackingNumber": "PYP7LC1UMWZOM0HE",
  "status": "in_transit",
  "shippedAt": "2024-06-29T00:12:33.223Z",
  "deliveredAt": null,
  "estimatedDeliveryAt": "2024-07-03T06:48:35.756Z",
  "createdAt": "2024-06-29T00:12:33.223Z"
}