ROSEHELP
🔑 Rose API

Rose API for developers

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 EnterpriseRead-onlyJSON over HTTPSv1
On this page
  1. Get an API key
  2. Sign each request
  3. Pages, limits and errors
  4. Store
  5. Items
  6. Sales
  7. Consignors and vendors
  8. Payouts
  9. Questions

1. Get an API key Rose

  1. A store owner or manager opens Administration › Settings › ROSE API.
  2. Press CREATE API KEY, give it a name (e.g. Website), and tick MAY READ CONTACT DETAILS only if the app needs consignors’ e-mails, phones and addresses.
  3. Copy the key (it starts with rose_) and give it to the developer privately. Rose shows it only once.
Each key reads one store only. A lost or leaked key: REVOKE it in the same place and make a new one; it stops working at once. A store can have 10 keys. The API needs Rose Enterprise ($149/mo); keys stop working if it ends.

2. Sign each request

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.

3. Pages, limits and errors

StatusCodeMeaning
400bad_dates, bad_limit, bad_offsetA parameter is missing or out of range
401unauthorizedNo key, a wrong key, or a revoked key
403no_enterprise, store_closedThe store doesn’t have Rose Enterprise, or its account isn’t open
404not_foundNo such item or account
429rate_limitedOver 120 requests a minute: wait and retry
500server_errorTry again; if it keeps happening, contact Consignor Connect

Endpoints

GET /store

The 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"}]}}

GET /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=.

ParameterWhat it does
accountOnly this consignor / vendor account number
locationOnly this location code
categoryOnly this category name
limit, offsetPaging
{"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}

GET /sales

Sold 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.

ParameterWhat it does
from, toRequired. Date range (yyyy-MM-dd, both included, at most 366 days)
accountOnly this account
locationOnly this location code
skuOnly this SKU
limit, offsetPaging
{"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}

GET /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.

ParameterWhat it does
vendortrue = vendors only, false = consignors only
limit, offsetPaging
{"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}

GET /payouts

Payouts 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.

ParameterWhat it does
from, toRequired. Date range (yyyy-MM-dd, both included, at most 366 days)
accountOnly this account
limit, offsetPaging
{"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}

Questions

Can the API change items or make sales?

Not in this version: it is read-only. Item and sale changes are made in Rose, Square or myPortal.

How fresh is the data?

It is read straight from the store’s Rose data at the moment you ask. Square sales show once Rose has posted them.

We have two stores. One key for both?

No: each key reads one store. Make a key in each store’s Rose.

Who can make keys?

Anyone who can open Administration › Settings in Rose. Revoke keys you no longer use.