Skip to content

Shoalrun documentation framework

For agents

Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.

API reference

Get a parcel

Updated 2026-10-19

GET/parcels/{parcelId}View examples

Read as Markdown

Fictional API example. This page demonstrates documentation features; its operations do not describe a live service.

This reference is generated from the OpenAPI description. It shows the operation contract; follow any related guides below for task steps and context.

OpenAPI for this operation: Download JSON.

GET /parcels/{parcelId}

Get a parcel

This lookup route does not use the API's default authentication.

Servers

https://lookup.api.cedar-parcel.example/v1 — Public lookup host

Authentication

No authentication required.

Parameters

`parcelId` (path)

Required

string

Responses

200: OK

application/json

Parcel found.

5 properties

parcelId string always present ⓘ
status enum<string> always present ⓘ

Available options: "label_created", "in_transit", "delivered", "exception"
declaredValue number always present ⓘ

minimum: 0; multipleOf: 0.01

Value in currency units, to the nearest cent.
recipient object always present ⓘ
2 properties
- city string always present ⓘ
- postalCode string always present ⓘ
events list of object may be absent ⓘ

Tracking history in chronological order.

Array items:

object
3 properties
- kind enum<string> always present ⓘ
  
  Available options: "pickup", "scan", "delivery"
- at string always present ⓘ
  
  format: date-time
- details string may be absent nullable ⓘ

404: Not Found

application/problem+json

No parcel has that identifier.

4 properties

type string always present ⓘ

format: uri
title string always present ⓘ
status integer always present ⓘ
detail string may be absent ⓘ

API data

Type placeholders show the JSON structure. Required and optional fields are described in the reference.

Response 200 · application/json

{
  "parcelId": "string",
  "status": "string",
  "declaredValue": "number",
  "recipient": {
    "city": "string",
    "postalCode": "string"
  },
  "events": [
    {
      "kind": "string",
      "at": "string (date-time)",
      "details": "string | null"
    }
  ]
}

Response 404 · application/problem+json

{
  "type": "string (uri)",
  "title": "string",
  "status": "integer",
  "detail": "string"
}

Examples from OpenAPI. Generated samples have not been executed.

Example request

Language

curl --request GET \
  --url 'https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID'

const response = await fetch("https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID", {
  method: "GET"
});

const data = await response.json();
console.log(data);

// Node.js 18 or newer provides a global fetch.
const response = await fetch("https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID", {
  method: "GET"
});

const data = await response.json();
console.log(data);

import requests

url = "https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID"

response = requests.get(url)
print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID", nil)
	if err != nil {
		panic(err)
	}
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

<?php

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

require 'net/http'
require 'uri'

uri = URI('https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)

response = http.request(request)
puts response.body

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        var request = new HttpRequestMessage(new HttpMethod("GET"), "https://lookup.api.cedar-parcel.example/v1/parcels/YOUR_PARCELID");
        var response = await client.SendAsync(request);
        Console.WriteLine(await response.Content.ReadAsStringAsync());
    }
}