Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 1.62 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.62 KB
Raw

zuo

Command-line interface to Zuora

Usage

Query a Zuora object knowing its ID

This feature is not (yet) implemented.

zuo query account zuora-account-id

Execute a ZOQL query

Standard usage will print out data in a table format.

zuo exec "SELECT Name FROM Product WHERE Status = 'Active'"

ZOQL query string is case-insensitive.

zuo exec "select name from product where status='active'"

If you don't use any WHERE clause with a String or Date argument, you can use single quotes.

zuo exec 'select name from product'

You can use the --json flag to print the raw JSON response from Zuora. It's useful when piping the output to a command-line JSON processor such as jq.

zuo exec --json "SELECT Id FROM Account WHERE Balance > 0" | jq '.size'

Setup

  1. Download the latest release
  2. Move the executable to /usr/local/bin
mv ~/Downloads/zuo /usr/local/bin
  1. Create an OAuth client in the Zuora UI
  2. Add the client ID and secret to your environment
# if using ZSH, put this in your ~/.zshrc
export ZUO_CLIENT_ID="my-client-id"
export ZUO_CLIENT_SECRET="my-client-secret"
export ZUO_BASE_URL="https://rest.apisandbox.zuora.com"

Why the Name?

Because it's Z-u-ora, not Zoura people!

(It's the same as Zendesk, not ZenDesk, no capital “d” my friend.)