How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wholechain Connect API

The Connect API from Wholechain — 19 operation(s) for connect.

Wholechain Connect API is one of 7 APIs that Wholechain publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Connect. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 6 JSON Schemas.

This API exposes 22 operations across 19 paths, and defines 110 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://connect.wholechain.com, https://connect-sandbox.wholechain.com.

22 operations 19 paths 110 schemas 1 DELETE6 GET12 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://connect.wholechain.com
Resource Areas
1

Paths & Operations 22

Across 19 paths, the API surfaces 22 operations — 1 DELETE, 6 GET, 12 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Connect 22
POST
/Integration
XML
XML 1 param body → 200
POST
/Integration/Events
Process events
ProcessEvents 1 param body → 200
POST
/Integration/Events/async
Enqueue events
EnqueueEvents 1 param body → 200
DELETE
/Integration/Events/{eventId}
Delete event
DeleteEvent 2 params → 200
POST
/Integration/Locations
Process locations
ProcessLocations 1 param body → 200
GET
/Integration/Locations
List locations
ListLocations 5 params → 200
PUT
/Integration/Location
Update location
UpdateLocation 1 param body → 200
GET
/Integration/Location/{locationId}
Get location
GetLocation 2 params → 200
GET
/Integration/PurchaseOrder
Get purchase order
GetPurchaseOrder 2 params → 200
PUT
/Integration/PurchaseOrder
Update purchase order
UpdatePurchaseOrder 1 param body → 200
POST
/Integration/Products
Process products
ProcessProducts 1 param body → 200
GET
/Integration/Products
Get paginated products
GetPaginatedProducts 23 params → 200
PUT
/Integration/Product
Update product
UpdateProduct 1 param body → 200
POST
/Integration/files/notification
Notify new file
NotifyNewFile body → 200
POST
/Integration/PackingList
Process packing list
ProcessPackingList 1 param body → 200
GET
/Integration/Jobs
Get jobs
GetJobs 7 params → 200
GET
/Integration/Inventory
Get inventory
GetInventory 4 params → 200
POST
/Integration/PurchaseOrders
Process purchase orders
ProcessPurchaseOrders 1 param body → 200
POST
/Integration/Documents
Uploads one supporting document for the account that owns the API key.
UploadDocument 10 params body → 200422
POST
/Integration/PurchaseOrder/review
Review purchase order
ReviewPurchaseOrder 1 param body → 200
POST
/Integration/PurchaseOrder/share
Share purchase order
SharePurchaseOrder 1 param body → 200
POST
/Integration/PurchaseOrders/upload
Upload purchase orders
UploadPurchaseOrders 1 param body → 200

Schemas 110

The contract defines 110 schemas that model the data the API accepts and returns. The most detailed are Wholechain.API.Contracts.PurchaseOrders.Responses.PurchaseOrderResponse (41 properties), Wholechain.API.Contracts.Products.Responses.ProductResponse (35 properties), Wholechain.Connect.Application.Services.FileService.FileUploadEvent (28 properties), Wholechain.API.Contracts.Locations.Responses.LocationResponse (28 properties). Each schema is shown below with its type and property counts.

Wholechain.API.Contracts.DataPolicy.Responses.DataPolicyDocumentValueResponse
object
2 properties
Wholechain.API.Contracts.Products.Responses.ProductOwnerInfoContract
object
Identifies the owning trade partner of a trade item (product) from the viewer's perspective. Wholechain.API.Contracts.Products.Responses.ProductOwnerInfoContra…
4 properties
Wholechain.API.Contracts.Connect.Integration.UpdatePurchaseOrder.ConnectUpdatePurchaseOrderResponse
object
4 properties
FluentValidation.Severity
string
Wholechain.API.Contracts.PurchaseOrders.Responses.LinkedEventLocationSummary
object
Lightweight location summary for linked events in purchase order lists. Contains only the fields loaded by the list query (no nested trade partner).
5 properties 2 required
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.ProcessEventResult
object
10 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectLineItemStoreAllocation
object
2 properties 2 required
Wholechain.API.Contracts.Locations.Responses.ListLocationsResponse
object
2 properties
Wholechain.API.Contracts.Documents.Responses.ExternalDocumentUploadResponse
object
1 property
Wholechain.API.Contracts.PurchaseOrders.Enums.PurchaseOrderVisibilityContract
string
Purchase Order Visibility Contract.
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectLocationDetails
object
15 properties
Wholechain.API.Contracts.Products.ProductMasterDataContract
object
7 properties
Wholechain.API.Contracts.Connect.Integration.CreateConnectResponse
object
4 properties
Wholechain.API.Contracts.Connect.Integration.TradePartnerResult
object
5 properties
Wholechain.API.Contracts.Locations.VesselInformationContract
object
7 properties
Wholechain.API.Contracts.TradePartners.Enums.TradePartnerTypeContract
string
Represents trade partner types that have Wholechain accounts or not.
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectPurchaseOrderLinkedEventProduct
object
4 properties
Wholechain.API.Contracts.Connect.Integration.ConnectInventoryResponse
object
1 property
Wholechain.API.Contracts.Jobs.Responses.JobResponse
object
8 properties
Wholechain.Connect.Application.Products.Commands.UpdateProduct.ConnectUpdateProductRequest
object
1 property
Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceTypeContract
string
Wholechain.API.Contracts.Locations.Responses.LocationResponse
object
28 properties
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.ProcessEventsResponse
object
6 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectProductDetails
object
12 properties 1 required
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectPurchaseOrderLineItem
object
7 properties 2 required
Wholechain.API.Contracts.Locations.Responses.SharedWithContract
object
2 properties
Wholechain.Connect.Application.Locations.Commands.UpdateLocation.ConnectUpdateLocationRequest
object
1 property
Wholechain.API.Contracts.Connect.Integration.UpdateLocation.ConnectUpdateLocationResponse
object
4 properties
Wholechain.API.Contracts.Products.Enums.UnitDescriptorContract
string
Describes how a product simple unit of measurement is separated per unit descriptor. For example a product measured in KGM could have 5 KGM per Case.
Wholechain.API.Contracts.Products.Responses.SubProductResponse
object
4 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectPurchaseOrder
object
19 properties 5 required
Wholechain.API.Contracts.Documents.Responses.ExternalDocumentUploadResult
object
13 properties
Wholechain.API.Contracts.Connect.Integration.ProcessError
object
3 properties
Wholechain.API.Contracts.Jobs.Responses.JobStatusContract
string
Wholechain.API.Contracts.PurchaseOrders.Responses.LinkedShipmentProductPreview
object
5 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectPurchaseOrderLinkedEvent
object
6 properties
Wholechain.Connect.Application.Events.Commands.ProcessEvents.ProcessConnectEventsRequest
object
2 properties
Wholechain.API.Contracts.Products.Enums.ProductInventoryLocationFilterModeContract
string
Wholechain.API.Contracts.Events.Enums.EventTypeContract
string
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectEvent
object
13 properties
Wholechain.API.Contracts.Connect.Integration.ProductResult
object
5 properties
Wholechain.API.Contracts.PurchaseOrders.Enums.PurchaseOrderTypesContract
string
Wholechain.API.Contracts.Products.Responses.ProductSharedWithContract
object
3 properties
Wholechain.API.Contracts.DataPolicy.Responses.DataPolicyCertificationValueResponse
object
6 properties
Wholechain.API.Contracts.Products.Enums.ProductIdentifierTypeContract
string
Wholechain.API.Contracts.Products.Enums.SimpleUnitOfMeasurementContract
string
Simple units of measurement for products.
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.ExternalShipmentFailureResult
object
2 properties
Wholechain.API.Contracts.Jobs.Responses.GetPaginatedJobsResponse
object
7 properties
Wholechain.API.Contracts.Shipments.Requests.ShipmentDirectionContract
string
Wholechain.API.Contracts.Connect.Integration.ContainerResult
object
3 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectTradePartner
object
6 properties 1 required
Wholechain.API.Contracts.Connect.Integration.ProductInstanceResult
object
6 properties
Wholechain.API.Contracts.Common.Enums.BlockchainTypeContract
string
Enum that represents different blockchain providers.
Wholechain.API.Contracts.Shipments.Requests.ShipmentStatusContract
string
Wholechain.API.Contracts.ProductCommodities.Responses.ProductCommodityResponse
object
4 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.CustomProperty
object
3 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectLocation
object
4 properties
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.DirectShipMissingLotResult
object
4 properties
Wholechain.API.Contracts.Connect.Integration.ConnectInventoryProduct
object
3 properties
Wholechain.API.Contracts.Locations.Responses.LocationOwnerInfoContract
object
Identifies the owning trade partner of a location from the viewer's perspective. Wholechain.API.Contracts.Locations.Responses.LocationOwnerInfoContract.OwnerTr…
4 properties
Wholechain.API.Contracts.Connect.Integration.ProcessLocations.ProcessLocationResult
object
2 properties
Wholechain.API.Contracts.ProductBrands.Responses.ProductBrandResponse
object
5 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectProduct
object
4 properties
Wholechain.API.Contracts.Common.GeoCoordinatesContract
object
2 properties
Wholechain.API.Contracts.Products.Responses.ProductGoodKindResponse
object
3 properties
Wholechain.Connect.Application.Events.Commands.ProcessProducts.ProcessConnectProductsRequest
object
1 property
Wholechain.API.Contracts.Locations.LocationContactInformationContract
object
3 properties
Wholechain.Connect.Application.Services.FileService.FileUploadEvent
object
28 properties
Wholechain.API.Contracts.Products.Responses.ProductResponse
object
35 properties
Wholechain.API.Contracts.Products.Enums.ProductSharedPermissionContract
string
Describes a permission that an account has over a product.
Wholechain.API.Contracts.PurchaseOrders.Responses.LinkedEventTradePartnerSummary
object
Lightweight trade partner summary for linked events in purchase order lists. Contains only the fields loaded by the list query.
4 properties 2 required
Wholechain.API.Contracts.Connect.Integration.ProcessProducts.ProcessProductResult
object
2 properties
Wholechain.API.Contracts.Connect.Integration.UpdateProduct.ConnectUpdateProductResponse
object
4 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectProductClassification
object
3 properties
Wholechain.API.Contracts.Connect.Integration.SharePurchaseOrder.ConnectSharePurchaseOrderRequest
object
2 properties 2 required
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Wholechain.Connect.Application.Locations.Commands.ProcessLocations.ProcessConnectLocationsRequest
object
1 property
Wholechain.API.Contracts.Connect.Integration.ConnectEventStatus
string
Wholechain.Connect.Application.Shipments.Commands.ProcessJsonFile.ConnectEventResponse
object
3 properties
Wholechain.API.Contracts.Events.Responses.TraceabilityLotCodeSourceContract
object
13 properties
Wholechain.API.Contracts.PurchaseOrders.Responses.LinkedShipmentSummary
object
17 properties 8 required
Wholechain.API.Contracts.Connect.Integration.ReviewPurchaseOrder.ConnectReviewPurchaseOrderRequest
object
3 properties 3 required
Wholechain.API.Contracts.LocationGroups.Responses.LocationGroupResponse
object
4 properties
Wholechain.API.Contracts.Connect.Integration.EventResult
object
8 properties
Wholechain.API.Contracts.Common.AddressContract
object
8 properties
Wholechain.API.Contracts.PurchaseOrders.Responses.LineItemStoreAllocationResponse
object
6 properties 3 required
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.DocumentNotAttachedResult
object
2 properties
Wholechain.API.Contracts.PurchaseOrders.Responses.PurchaseOrderResponse
object
41 properties 4 required
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectPurchaseOrderTpLocProduct
object
3 properties
Wholechain.Connect.Application.PurchaseOrders.Commands.ConnectUpdatePurchaseOrderRequest
object
1 property
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectCertificationInfo
object
5 properties
Wholechain.API.Contracts.Connect.Integration.ConnectInventoryLot
object
2 properties
Wholechain.API.Contracts.DataPolicy.Responses.DataPolicyKeyDataElementValueResponse
object
4 properties
Wholechain.Connect.Application.PurchaseOrders.Commands.ProcessConnectPurchaseOrdersRequest
object
1 property
Wholechain.API.Contracts.Connect.Integration.UpdatePurchaseOrder.ConnectPurchaseOrderUpdate
object
10 properties 2 required
System.Net.HttpStatusCode
string
Wholechain.API.Contracts.Products.Responses.PaginatedProductsResponse
object
8 properties
Wholechain.API.Contracts.Events.Enums.ShipmentTypeContract
string
Wholechain.API.Contracts.Products.Enums.ProductSharingPolicyContract
string
Wholechain.API.Contracts.Connect.Integration.LocationResult
object
6 properties
Wholechain.API.Contracts.Locations.Enums.LocationTypeContract
string
Wholechain.API.Contracts.Connect.Integration.ProcessEvents.DirectShipFallbackResult
object
2 properties
FluentValidation.Results.ValidationFailure
object
7 properties
Wholechain.Connect.Application.Events.Commands.EnqueueEvents.EnqueueEventsResponse
object
3 properties
Wholechain.API.Contracts.PurchaseOrders.Responses.PurchaseOrderLineItemResponse
object
11 properties 3 required
Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectLocationCustomData
object
3 properties
Wholechain.API.Contracts.Connect.Integration.ConnectInventoryLocationQuantity
object
4 properties
Wholechain.API.Contracts.PurchaseOrders.Enums.PurchaseOrderStatusContract
string
Wholechain.API.Contracts.DataPolicy.Responses.DataPolicyElementsResponse
object
3 properties
Wholechain.API.Contracts.Connect.Events.Requests.V2.PutConnectProductRequest
object
Request body for PUT Products/External. Same as Wholechain.API.Contracts.Connect.Events.Requests.V2.ConnectProduct but without UpdateIfExists (always treated a…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wholechain-connect-api-openapi.yml Raw ↑

Other APIs Wholechain publishes across the network.

Wholechain Edi API
Wholechain EPCIS Interface API
Wholechain EPCIS Legacy Interface API
Wholechain Events API
Wholechain External O Auth API
Wholechain Health API
Where this information came from

This is an independent, third-party profile of Wholechain Connect API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.