Wholechain

Wholechain Events API

The Events API from Wholechain — 1 operation(s) for events.

GitHub OpenAPI

Operations 1

GET /epcis/Events/details Return a list of events details for the supply chain #

Documentation

📖
Documentation
https://developers.wholechain.com/EventsV2/Introduction/
📖
APIReference
https://connect.wholechain.com/swagger/index.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/wholechain/openapi/wholechain-events-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-api-contracts-connect-events-requests-v2-connect-purchase-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-connect-application-services-file-service-file-upload-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-api-contracts-connect-integration-process-events-process-events-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-api-contracts-products-responses-paginated-products-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-api-contracts-events-responses-paginated-event-details-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/wholechain/json-schema/wholechain-wholechain-api-contracts-jobs-responses-get-paginated-jobs-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/wholechain:wholechain-events-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wholechain-events-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Wholechain Events API
  version: v1
  contact:
    url: https://www.connect.wholechain.com
  description: 'Operations tagged Events across 2 of this provider''s published API definitions: wholechain-connect-swagger.json, wholechain-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://connect.wholechain.com
  description: Production (Swagger UI host per https://developers.wholechain.com/GettingStarted/Swagger/)
- url: https://connect-sandbox.wholechain.com
  description: Sandbox
tags:
- name: Events
paths:
  /epcis/Events/details:
    get:
      tags:
      - Events
      summary: Return a list of events details for the supply chain
      operationId: ListEventDetails
      parameters:
      - name: LotSerial
        in: query
        schema:
          type: string
      - name: PurchaseOrder
        in: query
        schema:
          type: string
      - name: PerformTraceback
        in: query
        schema:
          type: boolean
      - name: PageNumber
        in: query
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: SortBy
        in: query
        schema:
          type: string
      - name: X-API-KEY
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse'
components:
  schemas:
    Wholechain.API.Contracts.Products.Enums.SimpleUnitOfMeasurementContract:
      enum:
      - Kgm
      - Lbs
      - Cases
      - Units
      - Item
      - Lbr
      - Pint
      - Each
      - Bags
      - Boxes
      - Dozens
      - Gallons
      - Ounces
      - Packs
      - Quarts
      - Bushels
      - Trays
      - Tubs
      - Sides
      - Loins
      type: string
      description: Simple units of measurement for products.
    Wholechain.API.Contracts.ProductInstances.ProductInstanceCertificationContract:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        standard:
          type:
          - string
          - 'null'
        agency:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        identification:
          type:
          - string
          - 'null'
      additionalProperties: false
    Wholechain.API.Contracts.Events.Responses.EventMasterDataContract:
      type: object
      properties:
        keyDataElementDefinitionId:
          type:
          - string
          - 'null'
          description: 'Optional reference to a KDE definition. When provided, this ties the master data

            to a specific KDE for data policy validation and reporting.'
          format: uuid
        name:
          type:
          - string
          - 'null'
        namespace:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        propertyLocation:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Enums.EventCustomPropertyLocationContract'
      additionalProperties: false
    Wholechain.API.Contracts.Common.AddressContract:
      type: object
      properties:
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        addressLine1:
          type:
          - string
          - 'null'
        addressLine2:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        geoCoordinates:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Common.GeoCoordinatesContract'
        displayAddress:
          type:
          - string
          - 'null'
      additionalProperties: false
    Wholechain.API.Contracts.Events.Enums.EventCustomPropertyLocationContract:
      enum:
      - ILMD
      - Extension
      - Mda
      - Custom
      type: string
      description: Locates where the custom data is located in the EPCIS XML.
    Wholechain.API.Contracts.Products.ProductMasterDataContract:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        namespace:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        elementId:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
          format: uuid
        keyDataElementDefinitionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    Wholechain.API.Contracts.Events.Responses.PaginatedEventDetailsResponse:
      type: object
      properties:
        totalPages:
          type: integer
          format: int32
          readOnly: true
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        totalItems:
          type: integer
          format: int64
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.EventDetailResponse'
        hasNextPage:
          type: boolean
          readOnly: true
        hasPreviousPage:
          type: boolean
          readOnly: true
      additionalProperties: false
    Wholechain.API.Contracts.Common.GeoCoordinatesContract:
      type: object
      properties:
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
      additionalProperties: false
    Wholechain.API.Contracts.Events.Enums.TransformationTypeContract:
      enum:
      - Input
      - Output
      type: string
    Wholechain.API.Contracts.Events.Responses.ErrorDeclarationContract:
      required:
      - reason
      type: object
      properties:
        reason:
          type:
          - string
          - 'null'
          format: uri
        declarationTime:
          type: string
          format: date-time
        correctingEventID:
          type:
          - string
          - 'null'
      additionalProperties: false
    Wholechain.API.Contracts.Events.Responses.EventDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        eventId:
          type: string
          format: uuid
        instanceId:
          type: string
          format: uuid
        isContainer:
          type: boolean
          readOnly: true
        containerId:
          type:
          - string
          - 'null'
          deprecated: true
        containerIdentifier:
          type:
          - string
          - 'null'
        containerEntityId:
          type:
          - string
          - 'null'
          format: uuid
        eventType:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Enums.EventTypeContract'
        externalIdentifier:
          type:
          - string
          - 'null'
        productName:
          type:
          - string
          - 'null'
        productId:
          type: string
          format: uuid
        traceabilityLotCode:
          type:
          - string
          - 'null'
        referenceDocumentId:
          type:
          - string
          - 'null'
        referenceDocumentType:
          type:
          - string
          - 'null'
        tlcSource:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceContract'
        lotSerial:
          type:
          - string
          - 'null'
        quantity:
          type:
          - number
          - 'null'
          format: double
        locationName:
          type:
          - string
          - 'null'
        companyName:
          type:
          - string
          - 'null'
        eventDate:
          type: string
          format: date-time
        eventLoggedDate:
          type: string
          format: date-time
        createdTime:
          type:
          - string
          - 'null'
          format: date-time
        unitOfMeasure:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Products.Enums.SimpleUnitOfMeasurementContract'
        identifierType:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Products.Enums.ProductIdentifierTypeContract'
        unitDescriptor:
          type:
          - string
          - 'null'
        unitQuantity:
          type:
          - string
          - 'null'
        businessStep:
          type:
          - string
          - 'null'
        disposition:
          type:
          - string
          - 'null'
        invoiceNumber:
          type:
          - string
          - 'null'
        eventTimezoneOffset:
          type:
          - string
          - 'null'
        purchaseOrder:
          type:
          - string
          - 'null'
        address:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Common.AddressContract'
        masterData:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.EventMasterDataContract'
        certifications:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Wholechain.API.Contracts.ProductInstances.ProductInstanceCertificationContract'
        instanceMasterData:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Wholechain.API.Contracts.ProductInstances.InstanceMasterDataContract'
        productMasterData:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Wholechain.API.Contracts.Products.ProductMasterDataContract'
        transformType:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Enums.TransformationTypeContract'
        errorDeclaration:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.ErrorDeclarationContract'
        deleted:
          type: boolean
        locationExternalIdentifier:
          type:
          - string
          - 'null'
        tradePartnerExternalIdentifier:
          type:
          - string
          - 'null'
        shipFromLocationName:
          type:
          - string
          - 'null'
        shipToLocationName:
          type:
          - string
          - 'null'
        shipFromLocationExternalIdentifier:
          type:
          - string
          - 'null'
        shipToLocationExternalIdentifier:
          type:
          - string
          - 'null'
        shipFromTradePartnerName:
          type:
          - string
          - 'null'
        shipFromTradePartnerExternalIdentifier:
          type:
          - string
          - 'null'
        shipToTradePartnerName:
          type:
          - string
          - 'null'
        shipToTradePartnerExternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceContract:
      type: object
      properties:
        locationName:
          type:
          - string
          - 'null'
        companyName:
          type:
          - string
          - 'null'
        identifier:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceTypeContract'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        geoCoordinates:
          $ref: '#/components/schemas/Wholechain.API.Contracts.Common.GeoCoordinatesContract'
      additionalProperties: false
    Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceTypeContract:
      enum:
      - Identifier
      - MasterData
      type: string
    Wholechain.API.Contracts.ProductInstances.InstanceMasterDataContract:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        namespace:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        elementId:
          type:
          - string
          - 'null'
        keyDataElementDefinitionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    Wholechain.API.Contracts.Events.Enums.EventTypeContract:
      enum:
      - Commission
      - Observe
      - Ship
      - Transform
      - Aggregation
      - Decommission
      - Disaggregation
      - Receive
      type: string
    Wholechain.API.Contracts.Products.Enums.ProductIdentifierTypeContract:
      enum:
      - Lot
      - Serial
      type: string
x-refined-from:
- wholechain-connect-swagger.json
- wholechain-openapi.yml
x-provenance:
  method: harvested
  publisher: Wholechain
  source: https://connect.wholechain.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)