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

Fulfil Model Interface API

The generic model interface applicable to any Fulfil model.

Fulfil Model Interface API is one of 10 APIs that Fulfil publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Model Interface. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{merchant_id}.fulfil.io/api/v2.

8 operations 5 paths 4 schemas 1 DELETE2 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://{merchant_id}.fulfil.io/api/v2
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Fulfil Model Interface API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (apiKeyAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • apiKeyAuth — Personal access token for private integrations, sent in the X-API-KEY header. Fulfil also accepts the token via HTTP Basic authentication.
  • oauth2 — OAuth 2.0 authorization code flow for public apps.

Paths & Operations 8

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

Model Interface 8

The generic model interface applicable to any Fulfil model.

GET
/model/{model_name}
Search records of a model
searchModel 6 params → 200401
POST
/model/{model_name}
Create records of a model
createModelRecords 1 param body → 201401422
GET
/model/{model_name}/{id}
Read a record
readModelRecord 3 params → 200401404
PUT
/model/{model_name}/{id}
Update a record
updateModelRecord 2 params body → 200401404422
DELETE
/model/{model_name}/{id}
Delete a record
deleteModelRecord 2 params → 200401404
PUT
/model/{model_name}/search_read
Search and read records in one call
searchReadModel 1 param body → 200401
PUT
/model/{model_name}/count
Count records
countModel 1 param body → 200401
PUT
/model/{model_name}/{method}
Call a model method (action)
callModelMethod 2 params body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SearchReadRequest (5 properties), Error (3 properties), Record (1 property). Each schema is shown below with its type and property counts.

SearchReadRequest
object
5 properties
Error
object
3 properties
Record
object
A Fulfil record. Fields vary by model; every persisted record has an integer id. Additional model-specific fields are permitted.
1 property
Domain
array
A Fulfil domain filter - a list of clauses such as ["name", "ilike", "iphone"] combined with logical operators.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fulfil-io-model-interface-api-openapi.yml Raw ↑

Other APIs Fulfil publishes across the network.

Fulfil Authentication API
Fulfil Customers API
Fulfil Inventory & Stock API
Fulfil Manufacturing API
Fulfil Products & Variants API
Fulfil Purchases API
Fulfil Sales Orders API
Fulfil Shipments API
Fulfil Webhooks API
Where this information came from

This is an independent, third-party profile of Fulfil Model Interface 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.