ROSEHELP
Read a store’s items, sales, consignors / vendors and payouts as JSON, for the store’s website, spreadsheets or other apps. Read-only: the API never changes store data. For the store’s own developers.
Full API reference for developers → (every field, code samples, Try it, OpenAPI file)
rose_) and give it to the developer privately. Rose shows it only once.Base address: https://app.shr-consignorconnect.com/rose/api/v1. Send the key in the Authorization header of every request (HTTPS only):
curl -H "Authorization: Bearer rose_XXXXXXXXXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://app.shr-consignorconnect.com/rose/api/v1/items?limit=50"Never put the key in a web page, an app people download, or a public code repository: call the API from your server.
{"data":[...], "limit":100, "offset":0, "next_offset":100}. Ask again with offset=next_offset until it is null. limit is 1–500 (default 100).yyyy-MM-dd; from and to are both included, at most 366 days per request./store).{"error":{"code":"...","message":"..."}}:| Status | Code | Meaning |
|---|---|---|
| 400 | bad_dates, bad_limit, bad_offset | A parameter is missing or out of range |
| 401 | unauthorized | No key, a wrong key, or a revoked key |
| 403 | no_enterprise, store_closed | The store doesn’t have Rose Enterprise, or its account isn’t open |
| 404 | not_found | No such item or account |
| 429 | rate_limited | Over 120 requests a minute: wait and retry |
| 500 | server_error | Try again; if it keeps happening, contact Consignor Connect |
/storeThe store's name, currency, time zone and locations (location codes are used as filters below). preview = true while the store is still trying the new Rose (a copy of its data).
{"data":{"store":"MyStore","name":"My Store","preview":false,"currency_symbol":"$","timezone":"America/New_York",
"locations":[{"code":"1","name":"Main Street"}]}}/items and /items/{sku}Items in stock (on the floor), in SKU order. /items/{sku} returns one item; a sold item is under /sales?sku=.
| Parameter | What it does |
|---|---|
account | Only this consignor / vendor account number |
location | Only this location code |
category | Only this category name |
limit, offset | Paging |
{"data":[{"sku":"100245","account":"1042","description":"Blue denim jacket","brand":"Levi's","category":"Outerwear",
"size":"M","color":"Blue","quantity":1,"price":38.00,"cost":0,"consignor_split_percent":50,"shelf_date":"2026-10-02",
"expires":"2026-12-31","never_expires":false,"no_discounts":false,"location":{"code":"1","name":"Main Street"},"status":""}],
"limit":100,"offset":0,"next_offset":null}/salesSold item lines (sales and returns; fees, charges, credits and payouts are not sales and are left out), by date sold. paid_to_consignor tells whether the consignor's share has been paid out yet.
| Parameter | What it does |
|---|---|
from, to | Required. Date range (yyyy-MM-dd, both included, at most 366 days) |
account | Only this account |
location | Only this location code |
sku | Only this SKU |
limit, offset | Paging |
{"data":[{"sku":"100245","account":"1042","description":"Blue denim jacket","brand":"Levi's","category":"Outerwear","size":"M",
"quantity":1,"sold_price":38.00,"consignor_share":19.00,"fee":0,"card_fee":1.10,"discount":0,"tax":2.66,
"date_sold":"2026-11-03","paid_to_consignor":false,"date_paid":null,"location":{"code":"1","name":"Main Street"}}],
"limit":100,"offset":0,"next_offset":null}/consignors and /consignors/{account}Consignor and vendor accounts in account order, with their balance due. e-mail, phones and address are included only for keys allowed to read contact details.
| Parameter | What it does |
|---|---|
vendor | true = vendors only, false = consignors only |
limit, offset | Paging |
{"data":[{"account":"1042","name":"Jane Smith","business":"","vendor":false,"store_account":false,"split_percent":50,
"balance_due":57.25,"paid_ytd":412.00,"last_paid":"2026-10-15","created":"2025-03-08","status":"",
"email":"jane@example.com","phone_cell":"555-0100","phone_home":"","phone_business":"",
"address":{"line1":"1 Main St","line2":"","city":"Springfield","state":"IL","zip":"62701"}}],"limit":100,"offset":0,"next_offset":null}/payoutsPayouts made to consignors and vendors, by date. method is how it was paid as typed in Rose (e.g. CHECK, CASH); reference is the check or transfer number; id links the payout's receipt. A negative PARTIAL PAYOUT reverses one.
| Parameter | What it does |
|---|---|
from, to | Required. Date range (yyyy-MM-dd, both included, at most 366 days) |
account | Only this account |
limit, offset | Paging |
{"data":[{"id":"6f1c...","account":"1042","type":"PAYOUT","amount":412.00,"date":"2026-10-15","method":"CHECK",
"reference":"10233","location":{"code":"1","name":"Main Street"}}],"limit":100,"offset":0,"next_offset":null}Not in this version: it is read-only. Item and sale changes are made in Rose, Square or myPortal.
It is read straight from the store’s Rose data at the moment you ask. Square sales show once Rose has posted them.
No: each key reads one store. Make a key in each store’s Rose.
Anyone who can open Administration › Settings in Rose. Revoke keys you no longer use.