Get Marketplace Shipment Tracking Information Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developer.pattern.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Hub API MCP server": {
    "url": "https://developer.pattern.com/mcp"
  }
}

Close
GET /v1/marketplace_shipments/{id}/tracking

Retrieve comprehensive tracking information for a marketplace shipment including status, location, POD/BOL availability, and timeline events. This endpoint provides real-time shipment tracking data for customer-facing applications.

Path parameters

  • id string Required

    The FBA Shipment ID to track

Responses

  • 200 application/json

    Tracking information retrieved successfully

    Hide response attributes Show response attributes object
    • shipment_id string Required

      Unique identifier for the shipment

    • fba_shipment_id string Required

      Amazon FBA shipment identifier

    • marketplace_name string Required

      Name of the marketplace or fulfillment center

    • unit_count integer | null

      Total number of units in the shipment

    • pro_number string | null

      Professional bill of lading number for LTL shipments

    • estimated_arrival string(date_time) | null

      Estimated arrival date and time in ISO 8601 format

    • carton_count integer Required

      Total number of cartons in the shipment

    • pod_exists boolean Required

      Whether proof of delivery documentation is available

    • bol_exists boolean Required

      Whether bill of lading documentation is available

    • pod_url string | null

      Presigned S3 URL for downloading proof of delivery document (expires in 1 hour)

    • bol_url string | null

      Presigned S3 URL for downloading bill of lading document (expires in 1 hour)

    • source string | null

      Inventory source for the shipment: IR number(s) if sourced from an Inventory Request, a middle-mile order identifier, or "Storage" as a fallback. Note: this reflects sync data that may not cover all historical shipments, in which case "Storage" may simply mean no sync data is available yet rather than a confirmed Storage source.

    • current_status object Required

      Current status information for the shipment

      Hide current_status attributes Show current_status attributes object
      • status string | null Required

        Current shipment status

        Values are created, in_transit, checked_in, receiving, or closed.

      • status_time string(date_time) | null Required

        Timestamp when the status was last updated

      • location string | null Required

        Current location of the shipment

    • statuses object Required

      Historical status transitions and timeline events

      Hide statuses attributes Show statuses attributes object
      • created object

        Shipment creation information

        Hide created attributes Show created attributes object
        • status_change_time string(date_time) Required

          When the shipment was created

        • location string | null

          Origin warehouse where shipment was created

      • in_transit object | null

        In-transit status information

        Hide in_transit attributes Show in_transit attributes object | null
        • status_change_time string(date_time) | null

          When the shipment departed

        • location string | null

          Origin location for the transit

        • data_missing boolean

          Whether some tracking data is incomplete

        • events array[object]

          Transit events and tracking updates

          Hide events attributes Show events attributes object
          • event_type string

            Type of tracking event

          • location string

            Location where event occurred

          • timestamp string(date_time)

            When the event occurred

          • description string

            Human-readable event description

      • checked_in object | null

        Check-in status information

        Hide checked_in attributes Show checked_in attributes object | null
        • status_change_time string(date_time) | null

          When the shipment was checked in

        • location string | null

          Destination fulfillment center

        • units_received integer | null

          Number of units received during check-in

        • cartons_received integer | null

          Number of cartons received during check-in

        • units_total integer | null

          Total units expected

        • cartons_total integer

          Total cartons expected

      • receiving object | null

        Receiving status information

        Hide receiving attributes Show receiving attributes object | null
        • status_change_time string(date_time) | null

          When receiving process started

        • location string | null

          Fulfillment center where receiving occurs

        • units_received integer | null

          Number of units processed during receiving

        • cartons_received integer | null

          Number of cartons processed during receiving

        • units_total integer | null

          Total units expected

        • cartons_total integer

          Total cartons expected

      • closed object | null

        Closed/completed status information

        Hide closed attributes Show closed attributes object | null
        • status_change_time string(date_time) | null

          When the shipment was closed/completed

        • location string | null

          Final destination fulfillment center

        • units_received integer | null

          Final count of units received

        • cartons_received integer | null

          Final count of cartons received

        • units_total integer | null

          Total units expected

        • cartons_total integer

          Total cartons expected

  • 422 application/json

    Bad request - missing or invalid parameters

    Hide response attributes Show response attributes object
    • error string Required

      Error message describing what went wrong

    • errors array[string]

      Array of error messages describing invalid parameters

GET /v1/marketplace_shipments/{id}/tracking
curl \
 --request GET 'https://api.pattern.com/hub/v1/marketplace_shipments/FBA15HDDV811/tracking' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "shipment_id": "FBA15HDDV811",
  "fba_shipment_id": "FBA15HDDV811",
  "marketplace_name": "Amazon Fulfillment Center",
  "unit_count": 150,
  "pro_number": "PRO123456",
  "estimated_arrival": "2025-06-27T10:00:00Z",
  "carton_count": 25,
  "pod_exists": true,
  "bol_exists": true,
  "pod_url": "https://s3.amazonaws.com/bucket/pod.pdf?X-Amz-Algorithm=...",
  "bol_url": "https://s3.amazonaws.com/bucket/bol.pdf?X-Amz-Algorithm=...",
  "source": "IR-SAMPLE-001",
  "current_status": {
    "status": "in_transit",
    "status_time": "2025-09-15T16:23:32.700Z",
    "location": "WAREHOUSE_A"
  },
  "statuses": {
    "created": {
      "status_change_time": "2025-06-25T08:00:00Z",
      "location": "WAREHOUSE_A"
    },
    "in_transit": {
      "status_change_time": "2025-06-26T08:00:00Z",
      "location": "WAREHOUSE_A",
      "data_missing": false,
      "events": [
        {
          "event_type": "departed",
          "location": "WAREHOUSE_A",
          "timestamp": "2025-06-26T08:00:00Z",
          "description": "Shipment departed from origin warehouse"
        }
      ]
    },
    "checked_in": {
      "status_change_time": "2025-06-27T09:30:00Z",
      "location": "FC_B",
      "units_received": 150,
      "cartons_received": 25,
      "units_total": 150,
      "cartons_total": 25
    },
    "receiving": {
      "status_change_time": "2025-06-27T10:00:00Z",
      "location": "FC_B",
      "units_received": 148,
      "cartons_received": 25,
      "units_total": 150,
      "cartons_total": 25
    },
    "closed": {
      "status_change_time": "2025-06-27T15:00:00Z",
      "location": "FC_B",
      "units_received": 148,
      "cartons_received": 25,
      "units_total": 150,
      "cartons_total": 25
    }
  }
}
Response examples (422)
{
  "error": "No Shipment Found",
  "errors": [
    "param is missing or the value is empty: id"
  ]
}