Insert sale period

Deprecated

POST

/api

Last modified:2024-08-14 15:22:03

To insert/update a sale period, it's necessary to make a POST call, passing a JSON body as specified below.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful enqueued or not

message: Error message

In case of success enqueud you will get this response:

{
    "success":true
}

In case of error you will get this response:

{
    "success":false,
    "message":"missing_params"
}

possible errors are:

missing_params: missing mandatory params

internal_server_error: generic error

Example

{
    "saleCode": "SALDI2023",
    "period": 1,
    "startDate": "2023-01-01",
    "endDate": "2023-04-02"
}

Fields

Field	Description	Type	Mandatory
saleCode	Profile sale code	String	✓
period	Period number (1, 2 or 3)	Int	✓
startDate	Start date of the period (format: yyyy-MM-dd)	String	✓
endDate	End date of the period (format: yyyy-MM-dd)	String	✓

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "saleCode": "SALDI2023",
    "period": 1,
    "startDate": "2023-01-01",
    "endDate": "2023-04-02"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api?cmd=insertSalePeriod_v4&appId=KEEPIT&applicationId=KEEPIT' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "saleCode": "SALDI2023",
    "period": 1,
    "startDate": "2023-01-01",
    "endDate": "2023-04-02"
}'

Responses

🟢200Success - Insert sale period

text/html

Example

{"success":true}

🟢200Error - Insert sale period

🟠422Unique constraint error

Modified at 2024-08-14 15:22:03

Insert sale profile

Add item price to sale period

Insert sale period

Example#

Fields#

Request

Request Code Samples

Responses

Example

Fields