Happy Business Starts Here

Valued Scholar

Metadata Retreival (Zuora supported objects)

Hi all,

1. Is there a way to retreive all the supported objects (like Invoice, Account, etc...) by Zuora through API (preferably SOAP).

2. Then retreive all the fields supported by the selected object above.

the https://www.zuora.com/apps/api/describe/[DataSource] doesn't work for me - it keeps prompting for username and password.

even though it's supplied the correct data - it keeps prompting again.

 

Any help would be appreciated.

 

 

 

Tags (1)
5 REPLIES 5
Zuora Support Moderator

Re: Metadata Retreival (Zuora supported objects)

Hello @_mikeSmith , the "Describe" URL is the correct way to get the list of objects and the fields of these objects. I am not aware of a SOAP capability where these can be queried via calls.

 

I have just verified if Describe works, and I got a correct response. Have you doublechecked if you're using the credentials for the right environment? If you're working on Apisandbox, the URL should be e.g. https://apisandbox.zuora.com/apps/api/describe/ or https://apisandbox.zuora.com/apps/api/describe/Account if I want to describe a specific object.

 

Alternatively, you can always download the latest WSDL containing all objects and fields by navigating to Settings > Billing > Download the Zuora WSDL on the Zuora UI.

 

Let me know if you're still having problems with Describe.



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Valued Scholar

Re: Metadata Retreival (Zuora supported objects)

@Viktor thanks for the quick answer. The problems was with the environment indeed.

Is there a chance to get the metadata back in JSON rather than XML?

Thanks.

 

Zuora Support Moderator

Re: Metadata Retreival (Zuora supported objects)

I have looked into this @_mikeSmith and it's not possible currently to get this in JSON. I'd suggest using an online XML to JSON converter, there are a lot of free tools for this purpose!



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Tags (1)
New Student

Re: Metadata Retreival (Zuora supported objects)

Hello @Viktor,

I want to retrieve the metadata in runtime in JSON format.

I could see there are changes of Json object structure vs. XML, some of the fields i could not find in Json and also name conflicts.

 

Can you suggest how to get the object metadata in runtime, because i have to get custom fields defined whenever we added or remove.

 

@_mikeSmith 

Do you find a way?

 

Thanks

Chandra

Zuora Support Moderator

Re: Metadata Retreival (Zuora supported objects)

Hi @chandra if you review our /action/ calls, these should be in the very same format and covering the same functionalities as the SOAP calls:

 

https://www.zuora.com/developer/api-reference/#tag/Actions

 

So whatever you see in SOAP's "describe" should also be available via an /action/query or an /action/create call etc. Let me know if this helps!



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √