Skip to main content
API docs by Redocly

Sales API (1.0)

Download OpenAPI specification:Download

Retrieves sales context for VM Number (also called Vippsnummer) and mPOS payments. Use together with the Report API and join on reference or pspReference. See the Sales API guide.

Merchant sales

Endpoints for retrieving sales events (captures and refunds) enriched with order lines, VAT, and categories. Use the feed endpoint for continuous synchronization, the date endpoint for accounting-date retrieval, or the reference endpoints to look up a specific order or transaction.

Get sales events for a ledger

Returns paginated sales events (captures and refunds) for the specified ledger. Use the cursor value to fetch subsequent pages.

path Parameters
ledgerId
required
string

Ledger ID provided by the Report API Get ledgers endpoint

query Parameters
cursor
string

Pagination cursor from a previous response. If omitted, the feed starts from the earliest available event.

pageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

Number of items per page (default: 100, max: 1000)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "hasMore": true
}

Get sales events for a ledger on a specific date

Returns paginated sales events (captures and refunds) for the specified ledger filtered by date.

path Parameters
ledgerId
required
string

Ledger ID provided by the Report API Get ledgers endpoint

ledgerDate
required
string <date>

Date to filter events by (YYYY-MM-DD)

query Parameters
cursor
string

Pagination cursor from a previous response. If omitted, the feed starts from the earliest available event for the given date.

pageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

Number of items per page (default: 100, max: 1000)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "hasMore": true
}

Get sales events by merchant reference

Returns sales events for the specified ledger matching the given merchant reference.

path Parameters
ledgerId
required
string

Ledger ID provided by the Report API Get ledgers endpoint

reference
required
string

The merchant's order reference

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "hasMore": true
}

Get sales events by PSP reference

Returns sales events for the specified ledger matching the given PSP reference.

path Parameters
ledgerId
required
string

Ledger ID provided by the Report API Get ledgers endpoint

pspReference
required
string

Payment service provider reference

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "hasMore": true
}