Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Noyo Partner Documents API

The Partner Documents API from Noyo — 4 operation(s) for partner documents.

Noyo Partner Documents API is one of 64 APIs that Noyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Partner Documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against the base URL https://fulfillment.noyo.com.

6 operations 4 paths 7 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://fulfillment.noyo.com
Resource Areas
1

Paths & Operations 6

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

Partner Documents 6
GET
/api/v1/partner_documents
List Partner Documents
getPartnerDocumentList 15 params → 200400401403
POST
/api/v1/partner_documents
---
createPartnerDocument body → 201404
GET
/api/v1/partner_documents/{id}/status
Get statuses for a partner document
getPartnerDocumentStatuses 3 params → 200404
DELETE
/api/v1/partner_documents/{id}/{version}
Delete a partner document
deletePartnerDocument 2 params → 204
PUT
/api/v1/partner_documents/{id}/{version}
Edit an existing Partner Document
editPartnerDocument 2 params body → 200400404409
GET
/api/v1/partner_documents/{partner_document_id}
Get Partner Document
getPartnerDocument 1 param → 200401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PartnerDocumentPublicResult (16 properties), PartnerDocumentPublicCreateRequest (12 properties), WorkflowStatus (6 properties), PartnerDocumentPublicEditRequest (4 properties). Each schema is shown below with its type and property counts.

PaginatedPartnerDocumentPublicResult
object
2 properties 2 required
PartnerDocumentPaginatedStatusResult
object
2 properties 2 required
PartnerDocumentPublicCreateRequest
object
12 properties 5 required
PartnerDocumentPublicResult
object
16 properties 9 required
Meta
object
4 properties 3 required
PartnerDocumentPublicEditRequest
object
4 properties
WorkflowStatus
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noyo-partner-documents-api-openapi.yml Raw ↑

Other APIs Noyo publishes across the network.

Noyo Carrier Mapped Field API
Noyo Carrier Sync API
Noyo Carriers API
Noyo Cases API
Noyo Condition API
Noyo Connection Eligibility API
Noyo Dependent API
Noyo Differences API
Noyo Discrepancies API
Noyo Eligibility Rules API
Noyo Employee API
Noyo Export API