Skip to main content

GET /v1/inflow_routes

Scope

write_inflow_routes

Request parameters

NameInTypeRequiredDescription
limitqueryintegeroptionalHow many entries to return (1-100). Defaults to 20.
offsetqueryintegeroptionalZero-based offset to start from. ⚠️ Entries updated mid-scan can be missed. For incremental order fetching, use after_id with updated_since instead.

Response example

{
"data": [
{
"id": "42",
"code": "a7Kq2mZ0xB",
"name": "夏キャンペーン",
"link": "string",
"redirect_url": "string",
"valid_from": "2026-09-01",
"valid_to": "2026-12-31",
"created_at": "2026-06-01T03:00:00Z"
}
],
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
}
}

Description

List inflow routes of the authenticated shop

Error response example

{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'write_inflow_routes'",
"request_id": "req_01H..."
}
}

Possible errors: 401 / 403