For the complete documentation index, see llms.txt. This page is also available as Markdown.

Save Retail Footfalls

Records footfalls – the number of people who walked into a store – in Logic ERP, by branch, date and hour, so that Logic ERP's sale-analysis reports can compare visitors with bills. Send one or many counts in one call. Use it when the visitor count comes from a door counter, a camera system or another app instead of being keyed in at the store.

Endpoint

Name
Detail

Address

https://your-server/api/SaveRetailFootFalls

Method

POST

Authorization

Basic Auth

The response and the messages every endpoint can return are explained in How Every API Call Works.

Request fields

The body is a list (a JSON array) of counts, even for one count; a single count sent without the [ ] is answered with the "no body" message (Payload Request Can`t be null. Please Check..., followed by a code in brackets) and Status: false. Field names are matched without regard to upper or lower case. Each count:

Field
Type
Required
Default
Meaning

BranchCode

number

Yes

0

Logic ERP's code of the store (Branch_Code in Get Branch Info). Must be a branch that exists.

FootFallDate

date

Yes

none

The day of the visits, yyyy-MM-dd. Any date is accepted – past, future, or outside the financial years of the company.

FootFallTime

number

No

0

The hour of the visits, 1 to 23 (for example 14 for 2 pm to 3 pm). 0, a negative number or leaving it out means "the hour at which Logic ERP receives the request".

FootFallCategory

text

No

empty

Who visited: FEMALE or KIDS, written exactly so, in capitals. Anything else – including MALE, Female or empty – records the visitors without a category. See the known issue below.

Count

number

Yes

0

How many people walked in. 0 is refused.

Rules Logic ERP applies

  • One record per visitor. Logic ERP stores each visitor separately, so a Count of 25 adds 25 footfalls. Send the count for the period, not each visit.

  • Nothing is replaced and nothing is checked for duplicates. Every call adds to the footfalls already recorded for that branch, day and hour. Sending the same request twice counts the visitors twice, so do not re-send a request that answered Status: true, and send each hour's count once (or only the visitors added since your last call).

  • The time. The visitors are recorded at the hour you send, with the minutes and seconds of (about) the moment Logic ERP processes the request; all visitors of one count get the same time. Reports that show footfalls by hour use the hour.

  • All or nothing. Every count in the list is checked first; the first count that fails a check stops the request with its message, which does not say which count it was, and nothing is saved. The counts are then saved together: if one fails while saving, none are kept.

  • A negative Count passes the check but adds nothing; the request still answers Status: true.

  • An empty list ([]) saves nothing and answers Status: true.

  • Footfalls are not tied to a financial year, so the date decides nothing beyond the day reported.

Known issue – the category is not recorded as Logic ERP's reports read it. Logic ERP's own footfall entry and its sale-analysis reports read the category as men, women and kids, but this endpoint records FEMALE in the place Logic ERP reads as men and KIDS in the place it reads as women; men and kids cannot be recorded at all. The total number of footfalls is correct. Until this is fixed, rely only on the totals in Logic ERP, and leave FootFallCategory empty if the men / women / kids split in Logic ERP's reports matters to your users.

Known issue – the "branch not found" message always shows 0. When BranchCode is not a branch in Logic ERP, the message reads Branch Code ( 0 ) not exists in Database... whatever code you sent. Check the codes in your list against Get Branch Info.

Example request

Two hours of door-counter readings for one store:

Test it

Send a request to the Logic ERP sandbox (a test company) from this page: open the block below, enter the sandbox user name and password (ask your Logic ERP support team), change the request if you like, and press Test it. This really saves in the sandbox, so use test values like the example. Each send adds the footfalls again – there is no duplicate check.

Save Retail Footfalls

post

Records footfalls – the number of people who walked into a store – in Logic ERP, by branch, date and hour, so that Logic ERP's sale-analysis reports can compare visitors with bills. Send one or many counts in one call. Use it when the visitor count comes from a door counter, a camera system or another app instead of being keyed in at the store.

Authorizations
AuthorizationstringRequired

The user name and password of your API site.

Bodyobject[]
BranchCodeintegerOptional

Logic ERP's code of the store (Branch_Code in Get Branch Info). Must be a branch that exists.

FootFallDatestringOptional

The day of the visits, yyyy-MM-dd. Any date is accepted – past, future, or outside the financial years of the company.

FootFallTimeintegerOptional

The hour of the visits, 1 to 23 (for example 14 for 2 pm to 3 pm). 0, a negative number or leaving it out means "the hour at which Logic ERP receives the request".

FootFallCategorystringOptional

Who visited: FEMALE or KIDS, written exactly so, in capitals. Anything else – including MALE, Female or empty – records the visitors without a category. See the known issue below.

CountintegerOptional

How many people walked in. 0 is refused.

Responses
200

Always HTTP 200. Check Status and Message.

application/json
StatusbooleanOptional

See the Status rules on this page.

MessagestringOptional

Why the call failed, or a note. The reason may be followed by technical detail - read the first line.

LastSavedCodeintegerOptional

See this page.

request_IDstringOptional

Logic ERP request number of this call.

post/SaveRetailFootFalls
POST /api/SaveRetailFootFalls HTTP/1.1
Host: demo.logicerp.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 195

[
  {
    "BranchCode": 3,
    "FootFallDate": "2026-10-30",
    "FootFallTime": 11,
    "FootFallCategory": "",
    "Count": 2
  },
  {
    "BranchCode": 3,
    "FootFallDate": "2026-10-30",
    "FootFallTime": 12,
    "FootFallCategory": "KIDS",
    "Count": 1
  }
]
{
  "Status": true,
  "Message": "text",
  "LastSavedCode": 1,
  "request_ID": "text"
}

Response

  • Status – true when the footfalls were saved.

  • Message – Success when saved; otherwise the reason (see below).

  • LastSavedCode – always 0.

  • request_ID – always empty. This endpoint does not record the request, so keep your own reference for each call.

Example response

Messages you may see

Nothing is saved when Status is false.

Message
Meaning
What to do

Invalid Branch Code...

A count had BranchCode 0 or left out.

Send the branch code for every count.

Branch Code ( 0 ) not exists in Database...

A count's BranchCode is not a branch in Logic ERP (the message always shows 0).

Use a code from Get Branch Info.

Foot Fall Date not Defined...

A count's FootFallDate was empty, left out or not a date.

Send the date as yyyy-MM-dd.

Foot Fall Count not Defined...

A count's Count was 0 or left out.

Leave counts of zero out of the list.

A technical error (with Status: false)

Saving failed – for example FootFallTime was more than 23. The reason may be followed by technical detail – read the first line.

Send the hour as 0 to 23 and send the request again.

Last updated