{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Fulfillments API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Fulfillments", "type": "folder" }, "items": [ { "info": { "name": "Create fulfillments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/fulfillments", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "\nCreates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation:\n* [Create a sales order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AD_Create_a_sales_order_line_item_with_fulfillments)\n* [Create a return order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/" }, { "info": { "name": "Retrieve a fulfillment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to retrieve." }, { "name": "fulfillment-items", "value": "", "type": "query", "description": "Return the related fulfillment items or not." } ] }, "docs": "Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:\n* [View details of a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_View_details_of_a_fulfillment)\n" }, { "info": { "name": "Update a fulfillment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to update." } ] }, "docs": "\n\nUpdates a specified fulfillment. The `state` field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the `Executing` state, or when the fulfillment is in the `Booked` state and the user has the \"Allow Edit Of Booked Order Line Items\" permission.\nThe following tutorial demonstrates how to use this operation:\n* [Update or cancel a fulfillment](https://knowledgecen" }, { "info": { "name": "Delete a fulfillment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/fulfillments/:key", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "key", "value": "", "type": "path", "description": "The id or fulfillment number of the Fulfillment to delete." } ] }, "docs": "Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the `Executing` state.\n" }, { "info": { "name": "Create fulfillment items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/fulfillment-items", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates one or multiple fulfillment items.\n" }, { "info": { "name": "Retrieve a fulfillment item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to retrieve." } ] }, "docs": "Retrieves the detailed information about a specified fulfillment item. \n" }, { "info": { "name": "Update a fulfillment item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to update." } ] }, "docs": "Updates a specified fulfillment item. \n" }, { "info": { "name": "Delete a fulfillment item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/fulfillment-items/:id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the Fulfillment Item to delete." } ] }, "docs": "Deletes a specified fulfillment item.\n" } ] } ], "bundled": true }