# Listings

> Status: Beta

> For the complete documentation index, see [llms.txt](https://developer.rippling.com/llms.txt). Every page is available as Markdown by adding .md to its URL.

> Closed beta. Create and manage App Shop listings using the Rippling CLI.

Source: https://developer.rippling.com/documentation/rippling-platform/rippling-cli/listings

> **Rippling:**
> Access to the Rippling CLI is gated behind the **Developer Program**, which is currently in a closed beta.

## Draft

### `rippling listing create`

Creates a draft App Shop listing. `--name` sets the display name. Creating a draft does not submit or publish the listing.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--name` | string | no | Display name shown in the App Shop. |
| `--package-id` | string | no | Package ID to associate with the listing. |
| `--package-version-id` | string | no | Published package version ID. |
| `--package-version-name` | string | no | Version label shown on the listing. |
| `--icon` | string | no | Listing icon URL. |
| `--input` | file | no | Full JSON body for additional listing metadata. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling --context developer-account listing create --name "My App" --package-id <package-id> --package-version-id <version-id> --package-version-name 1.0.0 --json
rippling --context developer-account listing create --input listing.json --json
```

### `rippling listing list`

Lists App Shop listings.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--limit` | string | no | Maximum listings to return. |
| `--offset` | string | no | Number of listings to skip. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling --context developer-account listing list
rippling --context developer-account listing list --json
```

### `rippling listing get`

Reads a specific listing.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--id` | string | yes | Listing ID. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing get --id <listing-id>
rippling listing get --id <listing-id> --json
```

### `rippling listing update`

Edits a listing draft that is still editable. Include only the fields to change.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--id` | string | yes | Listing ID to update. |
| `--name` | string | no | Display name shown in the App Shop. |
| `--package-id` | string | no | Package ID to associate with the listing. |
| `--package-version-id` | string | no | Published package version ID. |
| `--package-version-name` | string | no | Version label shown on the listing. |
| `--icon` | string | no | Listing icon URL. |
| `--input` | file | no | Full JSON body. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing update --id <listing-id> --name "Updated App Name" --json
rippling listing update --id <listing-id> --input listing-update.json --json
```

## Review & publication

### `rippling listing submit`

Submits a `DRAFT` listing for review, or resubmits a listing in `CHANGES_REQUESTED`.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--listing-id` | string | yes | Listing ID. |
| `--notes` | string | no | Notes recorded with the transition. |
| `--input` | file | no | Full JSON body. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing submit --listing-id <listing-id>
rippling listing submit --listing-id <listing-id> --notes "Updated the requested fields" --json
```

### `rippling listing withdraw`

Pulls a submission back to draft.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--listing-id` | string | yes | Listing ID. |
| `--notes` | string | no | Notes recorded with the transition. |
| `--input` | file | no | Full JSON body. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing withdraw --listing-id <listing-id>
rippling listing withdraw --listing-id <listing-id> --json
```

### `rippling listing publish`

Publishes a listing that is ready for publication.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--listing-id` | string | yes | Listing ID. |
| `--notes` | string | no | Notes recorded with the transition. |
| `--input` | file | no | Full JSON body. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing publish --listing-id <listing-id>
rippling listing publish --listing-id <listing-id> --json
```

### `rippling listing delist`

Delists a published listing.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--listing-id` | string | yes | Listing ID. |
| `--notes` | string | no | Notes recorded with the transition. |
| `--input` | file | no | Full JSON body. Cannot be combined with field flags. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing delist --listing-id <listing-id>
rippling listing delist --listing-id <listing-id> --json
```

### `rippling listing activity`

Shows review and publication history for a listing.

| Flag | Type | Required | Description |
| --- | --- | --- | --- |
| `--listing-id` | string | yes | Listing ID whose transitions should be returned. |
| `--json` | boolean | no | Print the response as indented JSON. |

*Example:*

```bash
rippling listing activity --listing-id <listing-id>
rippling listing activity --listing-id <listing-id> --json
```