Skip to main content

Paper

This document explains Antpocket's Paper feature.

A paper is a tool for publishing a space's product stock as a separate, shareable web page (URL).

Related menu path

  • Paper > My Papers — create a paper, change its title/visibility, copy the share URL, delete

1. Why use paper​

Viewing product stock inside the Antpocket app requires logging in and entering a space. But that process can be inconvenient or impossible in situations like:

  • Wanting to share current stock with people outside the space (trading partners, partner companies, external sales staff, etc.)
  • Wanting to check status on a single page in an always-on environment, like a meeting room monitor or tablet
  • Wanting to show head office or a warehouse manager only a specific warehouse's stock
  • Wanting to restrict access with a password depending on who you're sharing with

Paper solves these situations as follows:

  • Each paper has a unique URL ({host}/papers/{uuid}).
  • A paper can be accessed with just the URL, without logging in. (depending on its visibility setting)
  • A paper always shows the current stock status, not a snapshot from when it was published — it's always up to date.

The two types of paper​

TypeWhat it shows
All product stock (item_amount)Every product registered in the space, in a single table with every warehouse as a column
Stock by warehouse (place_item_amount)Only the quantities for the specific warehouse(s) selected (you can select multiple)

Visibility​

KeyNameDescription
privatePrivateOnly space members can view it. (default)
publicPublicAnyone who knows the URL can view it.
protectedProtectedOnly space members, or people who know the password, can view it.

2. How to use paper​

Page path: Paper > My Papers

This page lists every paper you've created in this space as cards.

2.1 Creating a paper​

Choose the type you want from the two buttons at the bottom of the screen.

① All product stock paper

  1. Click the Create a Paper Showing All Product Stock button.
  2. A card is created immediately, with Private as the default visibility.

② Stock-by-warehouse paper

  1. Click the Create a Paper Showing Stock for Specific Warehouses button.
  2. In the Select Warehouses dialog, check one or more warehouses to show.
  3. Click Confirm to create the paper.

A paper doesn't freeze data at the moment it's created. It always shows the current inventory management stock status as-is, so any inbound/outbound/adjustment/transfer is reflected on the paper immediately.

2.2 Opening a paper​

Click View on a paper card to open the paper's URL in a new tab.

  • A paper's URL has the form {host}/papers/{uuid}.
  • Since you're a space member, you can always view a paper regardless of its visibility.

2.3 Sharing: copy URL​

Click Share: Copy URL on a card to copy the paper's URL to your clipboard, with a "Link copied to clipboard." snackbar shown.

You can then share the copied URL via messenger, email, and so on. Whether the recipient can actually view the paper depends on its visibility setting.

2.4 Renaming​

  1. Click the pencil icon in the top right of the card.
  2. Select Rename from the context menu.
  3. Enter the new title in the prompt and confirm.

If left blank, the card shows "Untitled." If you're going to create multiple papers, we recommend giving each a title that matches its purpose.

2.5 Setting visibility (access settings)​

  1. Click the pencil icon in the top right of the card → Access Settings.
  2. Select one of three options with the radio buttons in the dialog.
    • Private — only space members can access it
    • Public — anyone with the URL can access it
    • Protected — only space members or people who know the password can access it
  3. If you select Protected, the password field below becomes active. Enter a password to share with external users.
  4. Click Save to apply.
Choosing a visibility level
  • If it's just for internal/team use, keep it Private.
  • If it's a public catalog anyone can see, set it to Public.
  • To share temporarily with a specific trading partner, use Protected with a password. Once you change the password, the old one no longer works.

2.6 Deleting a paper​

  1. Click the pencil icon in the top right of the card → Delete.
  2. Click Yes in the "Are you sure you want to delete it?" dialog to delete it immediately.
  3. A deleted paper's URL is no longer valid. Any link you've already shared externally will be broken, so proceed carefully.

3. FAQ​

Q. Does creating a paper freeze the data at that point in time?

No. A paper always shows current stock status. When inbound/outbound occurs, simply refreshing the paper page reflects the latest quantities.

Q. If I set visibility to Public, will all our company data show up in search engines?

The chance of someone stumbling onto the URL without knowing it is very low, but keep in mind that anyone who learns the URL can access it. For sensitive internal information, we recommend Protected with a password, or Private.

Q. Can other members manage a paper I created?

The My Papers page only shows papers you created. So renaming, changing visibility, and deleting must be done by the author themselves. Viewing (accessing the URL) of the paper itself is possible according to its visibility setting.

Q. Can I embed a paper on an external site or wiki?

The simplest approach is to share the URL Antpocket provides directly, or load it via an iframe in an external tool.

Appendix: Glossary​

TermDescription
Paper (paper)A shareable web page, published at a separate URL, showing a space's product stock.
All product stockA paper type showing every product and every warehouse in one table (item_amount).
Stock by warehouseA paper type showing only selected warehouses (place_item_amount).
PrivateA visibility level accessible only to space members.
PublicA visibility level accessible to anyone who has the URL.
ProtectedA visibility level accessible to space members or people who know the password.
uuidThe unique identifier assigned to each paper, included in the URL path.