Skip to main content
GET
/
api
/
plans
/
{type}
/
{id}
/
items
List plan items
curl --request GET \
  --url https://app.solya.app/api/plans/{type}/{id}/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "quantity": 5,
      "sizeId": "size-uuid-m",
      "status": "TO_REVIEW",
      "variantId": "var-uuid-adidas-jogger"
    }
  ],
  "total": 1
}

Authorizations

Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Path Parameters

type
enum<string>
required

Plan type. One of: RESTOCK, REBALANCE, MARKDOWN, SUPPLIER_RETURN, SUPPLIER_EXCHANGE, PRE_SEASON

Available options:
RESTOCK,
REBALANCE,
MARKDOWN,
SUPPLIER_RETURN,
SUPPLIER_EXCHANGE,
PRE_SEASON
id
string<uuid>
required

Unique identifier of the plan (UUID)

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

page
integer

Page number (1-based)

Required range: x <= 9007199254740991
pageSize
integer

Items per page

Required range: x <= 9007199254740991

Free-text search across variant/product/size labels

side
enum<string>

Filter by exchange side (RETURN or RECEIVE); only applicable for SUPPLIER_EXCHANGE

Available options:
RETURN,
RECEIVE

Response

Successful response

data
object
required
success
enum<boolean>
required
Available options:
true