Impartire
Create an account

API reference

Inbound deliveries

Every path is under https://impartire.com/api/v1. Generated from the API’s own contract, openapi.json (OpenAPI 3.1), which you can load into any OpenAPI tool. Errors are Problems — see Conventions.

GET/api/v1/inbound-deliveries

List deliveries made to the org

The receiver's view: what other orgs delivered to yours through a supply link, newest first, with where each landed in your org. For an OAuth token, its person needs the read-delivery permission (no platform-admin bypass); a key reads the whole org. 404 when the org does not have delivery, and for an OAuth token whose person may not read it. Also 404 when the org does not have supply links.

Scopes: delivery:read

Parameters
  • statusquery · "pending" | "delivered" | "failed" | "rejected"

    Only deliveries with this status.

  • created_afterquery · string (date-time)

    Only deliveries created strictly after this instant (ISO 8601 with offset), compared to the millisecond.

  • limitquery · integer

    Page size, default 50. Values above 100 are treated as 100.

  • cursorquery · string

    next_cursor from the previous page, with the other parameters unchanged.

Response 200InboundDeliveryList
  • dataarray of InboundDeliveryrequired

    Newest first (by created_at, then id).

    • idstring (uuid)required
    • supplier_orgobjectrequired

      The org that delivered.

      • idstring (uuid)required
      • namestringrequired
    • asset_namestring or nullrequired

      The supplier's asset name.

    • spec_profileSpecProfileRef or nullrequired

      Your spec revision it was delivered against.

      • idstring (uuid)required
      • namestringrequired
      • revisionintegerrequired

        The spec's revision: a published spec changes only by a new revision, which supersedes this one.

    • status"pending" | "delivered" | "failed" | "rejected"required
    • receivedobject or nullrequired

      Where the delivery landed in your org; null until it has.

      • asset_idstring (uuid) or nullrequired

        Your asset the delivery landed as (GET /api/v1/assets/{id}).

      • file_idstring (uuid) or nullrequired

        The landed primary file.

      • sha256string or nullrequired

        The landed primary file's SHA-256 (lowercase hex).

      • landed_atstring or nullrequired

        When it landed (ISO 8601).

      • redeliverybooleanrequired

        True when it landed as a new version of an asset an earlier delivery landed.

    • rejection_notestring or nullrequired

      Why you rejected it, when you did.

    • errorstring or nullrequired
    • created_atstring (date-time)required
    • delivered_atstring (date-time) or nullrequired
  • next_cursorstring or nullrequired

    Pass as cursor to get the next page; null means this is the last page.

Other responses
  • 401 unauthenticated — no key, or an unknown, revoked or expired one.
  • 403 insufficient-scope — the key lacks a required scope.
  • 404 not-found.
  • 422 validation — a bad filter, limit or cursor (errors[].path names it).
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.