POST /api/v1/management/canada/ sendQueuedDocuments/{clientId} – RetailForce

This endpoint initiates the transmission of documents to the WEB-SRM system. It is used when the transmission needs to be initiated manually following a connection failure.

In principle, for every document transmitted from the upstream system (POS system), the RetailForce client attempts to send all documents that have not yet been sent to the WEB-SRM system.

Manual transmission may be necessary if documents were generated during a connection failure and no further documents were generated for a prolonged period afterwards.

Here, for example, the user can manually trigger the transmission of transaction data by calling the function.

Result

A successful call to the endpoint (200)

transmits all documents that have not yet been sent to the WEB-SRM system.

Usage

where necessary, if documents have not yet been transmitted following a loss of connection to the WEB-SRM system.

Prerequisites

Canadian client in operation
Internet connection failure
Documents have been generated in offline mode and have not (yet) been transmitted to the WEB-SRM system

Form fields

The following information must be transmitted:

Designation	Description	Example
clientId	The uniqueClientId of the cash register (from RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Response

Possible responses:

Code	Description	Example
200	Documents have been transmitted to the WEB-SRM system	-