Zuora Documentation

Re: API Changelog

2018-04-24

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed.

 

  • Actions - Made the following updates to all operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Added a new Zuora-Request-Id response header.
  • Made the following updates to all CRUD operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Added a new Zuora-Request-Id response header.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Improved the Introduction section by clarifying information about accessing the API and removing redundant information.

  • Improved the Curl request sample for the “Get files” operation.

 

2018-04-22

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the April 2018 production release, R223.

 

  • OAuth - Made the following updates to the “Generate an OAuth token” operation:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead. The Zuora-Request-Id request and response headers were not previously documented.
  • Event triggers - Made the following updates to all operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead. The Zuora-Request-Id response header was not previously documented.
  • Notifications - Made the following updates to all operations except “Get callout notification histories” and “Get email notification histories”:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Corrected the request samples in the “Edit attachments” operation. Previously, all the request samples included a Curl request.

  • Added the following missing operations:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • Changed the name of the “Notifications” section. Previously, this section was called “Notification”.

  • Escaped single quotes in the Curl and PHP request samples for the following operations:

    • Query
    • Create an event trigger
    • Update an event trigger
    • Update custom fields on revenue items by revenue event number
    • Update custom fields on revenue items by revenue schedule number
    • Create revenue schedule for credit memo item (manual distribution)
    • Create revenue schedule for debit memo item (manual distribution)
    • Create revenue schedule for Invoice Item Adjustment (manual distribution)
    • Create revenue schedule for Invoice Item (manual distribution)
    • Distribute revenue across accounting periods
    • Create revenue schedule on subscription charge
  • In the “Get callout options” operation, added the following response headers:

    • Authorization
    • Zuora-Entity-Ids
  • Corrected the name of the IntegrationId__NS field in the request body of the “Subscribe” operation. Previously, the name of the field was incorrectly documented as IntegrationId_NS.

  • Corrected the name of the IntegrationId__NS field in the response bodies of the following operations:

    • Get invoices
    • CRUD: Retrieve InvoiceItem

    Previously, the name of the field was incorrectly documented as IntegrationId_NS.

  • Corrected the name of the Class__NS, Department__NS, and Location__NS fields in the request bodies of the following operations:

    • CRUD: Create ProductRatePlan
    • CRUD: Retrieve ProductRatePlan

    Previously, the names of the fields were incorrectly documented as Class_NS, Department_NS, and Location_NS.

  • Corrected the name of the Class__NS, Department__NS, and Location__NS fields in the response bodies of the following operations:

    • Get product catalog
    • CRUD: Retrieve ProductRatePlan

    Previously, the names of the fields were incorrectly documented as Class_NS, Department_NS, and Location_NS.