Reconciliation

List of reconciliation sessions

Changed on

Get list of reconciliation sessions. Each session includes its orders in the orders array

get/shops/{SHOP_ID}/reconciliations

Request

  • Base URL
    https://pos.pages.fm/api/v1
  • URL
    https://pos.pages.fm/api/v1/shops/{SHOP_ID}/reconciliations
  • Auth
    API key in query parameter api_key

Path parameters

SHOP_IDinteger required
Example:4

Shop ID

Query parameters

pageinteger
Example:1

Page number

page_sizeinteger
Example:10

Page size. Default 10, maximum 50 (larger values are clamped to 50)

sort_by'updated_at'
Example:updated_at

Sort by updated_at ascending (then system_id) for incremental sync. If omitted, sessions are sorted by creation time descending

startDateUpdatedAtinteger
Example:1758182400

Only sessions with updated_at >= this time (unix timestamp in seconds). Can be sent alone without endDateUpdatedAt

endDateUpdatedAtinteger
Example:1758268800

Only sessions with updated_at <= this time (unix timestamp in seconds)

include_removedboolean
Example:true

Include removed sessions (is_removed: true). Send true to enable

system_id[]integer[]

Filter by internal session ID. Also accepts a single value as system_id=123

display_idinteger
Example:92

Filter by session code shown on the shop

searchstring
Example:92 94

Search by display_id or custom_id of the session. Multiple codes can be separated by space or comma; matches any of them

partner_id[]string[]

Shipping partner ID on Pancake system (see Partner list). Also accepts a single value as partner_id=1

creator_idstring uuid
Example:d6e6a545-f102-439e-9943-8ac8369f9735

Filter by creator user ID

order_idinteger
Example:1418

Only sessions containing this order (internal order ID, system_id of the order)

startDateinteger
Example:1756684800

Start of the session creation time range (unix timestamp in seconds). Applied only when both startDate and endDate are sent

endDateinteger
Example:1759276800

End of the session creation time range (unix timestamp in seconds)

startDatePaidAtinteger
Example:1756684800

Start of the payment time range (unix timestamp in seconds). Applied only when both startDatePaidAt and endDatePaidAt are sent; sessions without paid_at are excluded

endDatePaidAtinteger
Example:1759276800

End of the payment time range (unix timestamp in seconds)

Response

Success

successboolean

Success status

page_numberinteger

Page number

page_sizeinteger

Page size

total_entriesinteger

Total entries

total_pagesinteger

Total pages

Changes

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status