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

Tradeverifyd Shipments API

Operations involving shipments

Tradeverifyd Shipments API is one of 13 APIs that Tradeverifyd publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 9 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 0.2.0.

Requests are made against a single base URL, https://api.tradeverifyd.com.

11 operations 9 paths 22 schemas 7 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.2.0
Base URL
https://api.tradeverifyd.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Tradeverifyd Shipments API declares 1 security scheme for authenticating requests. An API key is passed in the header as ocp-apim-subscription-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 7 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipments 11

Operations involving shipments

GET
/v1/shipments
Get Shipment List
get_shipments_shipments_get 5 params → 200400500422
POST
/v1/shipments
Create Shipment
create_shipment_shipments_post body → 200400422503500
GET
/v1/shipments/{shipment_id}
Get Shipment
get_shipment_by_id_shipments__shipment_id__get 1 param → 200400404500422
PUT
/v1/shipments/{shipment_id}
Update Shipment
update_shipment_shipments__shipment_id__put 1 param body → 200400404503500422
GET
/v1/shipment/{shipment_id}/sirs
Get supplier information requests
get_shipment_sirs_shipment__shipment_id__sirs_get 8 params → 200400500422
GET
/v1/shipment/sirs/{sir_id}
Get supplier information request
get_shipment_sir_shipment_sirs__sir_id__get 1 param → 200404500422
GET
/v1/shipment/sirs/{sir_id}/suggested_contact_info
Get supplier point of contact
get_shipment_sir_contact_info_shipment_sirs__sir_id__suggested_contact_info_get 1 param → 200404500422
POST
/v1/shipment/sirs/{sir_id}/status
Update supplier information request status
update_shipment_sir_status_shipment_sirs__sir_id__status_post 1 param body → 200400404500422
POST
/v1/shipment/{shipment_id}/upload
Upload a document to a shipment
upload_shipment_file_shipment__shipment_id__upload_post 2 params body → 200400401404500422
GET
/v1/shipments/{shipment_id}/cbps
Get CBP Requests for Shipment
get_cbp_requests_for_shipment_shipments__shipment_id__cbps_get 1 param → 200500422
GET
/v1/shipments/{shipment_id}/cbps/{vc_id}
Get CBP Requests for Shipment and VC
get_cbp_requests_for_shipment_and_vc_shipments__shipment_id__cbps__vc_id__get 2 params → 200500422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SupplierInformationRequestDetailResponse (17 properties), ShipmentDetailResponse (14 properties), CreateShipmentRequest (10 properties), UpdateShipmentRequest (9 properties). Each schema is shown below with its type and property counts.

UpdateShipmentRequest
object
Model for updating a shipment.
9 properties 3 required
ShipmentResponse
object
Response model for a shipment.
8 properties 6 required
SupplierInformationRequestListing
object
Wrapper for SIR responses
4 properties 4 required
earthstream_services__services__shipment__common__models__Pagination
object
Using to return paging information to the client. currentpage: the current page of data totalpages: the total number of pages totalrecords: the number of recor…
4 properties 4 required
HTTPValidationError
object
1 property
SupplierInformationRequestResponse
object
Response model for a supplier information request.
5 properties 4 required
SuggestedContactCitation
object
Citation information for suggested supplier contact references.
2 properties
ShipmentListingResponse
object
Response model for a list of shipments
4 properties 4 required
ShipmentStatus
string
Enum for shipment status.
app__schemas__shipments__CBPRequest
object
CBP Request information (shared schema for both public and internal APIs)
9 properties 9 required
ValidationError
object
3 properties 3 required
SupplierInformationRequestStatus
string
Enum for supplier information request status.
CBPRequestListing
object
List of CBP Requests (shared schema for both public and internal APIs)
1 property 1 required
ShipmentUploadResponse
object
Response for a shipment upload.
4 properties 3 required
ShipmentDetailResponse
object
Response model for a shipment response.
14 properties 6 required
Body_update_shipment_sir_status_shipment_sirs__sir_id__status_post
object
1 property 1 required
SupplierInformationRequestDetailResponse
object
Supplier information request detail response.
17 properties 5 required
SupplierInformationRequestFilter
object
Wrapper for SIR filters
4 properties 4 required
SuggestedContactAddress
object
Response model for a street address of a suggested supplier contact
6 properties
CreateShipmentRequest
object
Request model for creating a shipment.
10 properties 3 required
SupplierInformationSuggestedContactResponse
object
Response model for suggested contact information for a supplier
6 properties 1 required
Body_upload_shipment_file_shipment__shipment_id__upload_post
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tradeverifyd-shipments-api-openapi.yml Raw ↑

Other APIs Tradeverifyd publishes across the network.

Tradeverifyd Documents API
Tradeverifyd Entity API
Tradeverifyd Flags API
Tradeverifyd Organizations API
Tradeverifyd Relationships API
Tradeverifyd Reports API
Tradeverifyd Risk Events API
Tradeverifyd SCITT Reference APIs API
Tradeverifyd System API
Tradeverifyd Transparency Log API
Tradeverifyd US Customs API
Tradeverifyd Verifiable Credentials API
Where this information came from

This is an independent, third-party profile of Tradeverifyd Shipments 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.