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

Zuora Fulfillments API

Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment. For more information, see Overview of Order Line Items.

Zuora Fulfillments API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 4 paths, and defines 20 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

8 operations 4 paths 20 schemas 2 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 8

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

Fulfillments 8

Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment. For more informati…

POST
/v1/fulfillments
Create fulfillments
Create_Fulfillment 8 params → 200
GET
/v1/fulfillments/{key}
Retrieve a fulfillment
GET_Fulfillment 8 params → 200
PUT
/v1/fulfillments/{key}
Update a fulfillment
PUT_Fulfillment 8 params → 200
DELETE
/v1/fulfillments/{key}
Delete a fulfillment
Delete_Fulfillment 7 params → 200
POST
/v1/fulfillment-items
Create fulfillment items
Create_FulfillmentItem 8 params → 200
GET
/v1/fulfillment-items/{id}
Retrieve a fulfillment item
GET_FulfillmentItem 7 params → 200
PUT
/v1/fulfillment-items/{id}
Update a fulfillment item
PUT_FulfillmentItem 8 params → 200
DELETE
/v1/fulfillment-items/{id}
Delete a fulfillment item
Delete_FulfillmentItem 7 params → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are PutFulfillmentRequestType (15 properties), FulfillmentCommon (15 properties), CommonResponseType (3 properties), PutFulfillmentItemRequestType (3 properties). Each schema is shown below with its type and property counts.

FulfillmentCommon
object
15 properties
FulfillmentCustomFields
object
Container for custom fields of a Fulfillment object.
PutFulfillmentRequestType
object
15 properties
CommonResponseType
object
3 properties
PostFulfillmentsResponseType
PutFulfillmentItemRequestType
object
3 properties
GetFulfillmentResponseType
FulfillmentItemPost
PostFulfillmentItemsResponseType
FulfillmentItemPostFromFulfillmentPost
FulfillmentItemGet
FulfillmentGet
BillingOptions
object
2 properties
ProcessingOptions
object
Processing options for generating billing documents.
2 properties
GetFulfillmentItemResponseType
FulfillmentItemCustomFields
object
Container for custom fields of a Fulfillment Item object.
FulfillmentPost
PostFulfillmentsRequestType
object
2 properties
FulfillmentItemCommon
object
3 properties
PostFulfillmentItemsRequestType
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-fulfillments-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API