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

With this service you can specify prices or define a discount percentages

This web service is asynchronous, this means that the insert operations is enqueued.

After the prices have been inserted or an error has occured, the result can be sent to an optional callbackUrl specified in the request body

The web service response will be composed of:

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

message: Enqueued message or error message

In case of success enqueud you will get this response:

{
    "success":true,
    "message":"operation_equeued"
}

In case of error you will get this response:

{
    "success":false,
    "message":"The period is invalid"
}

On successful response to the callback:

totalItems -> Number of items passed to the web service

itemsInError -> Number of items not inserted

itemsError -> Array where each item represents the item in error. ItemPosition is the position of the item in the request array.

{
  "success": true,
  "message": "Prices correctly inserted",
  "totalItems": 3,
  "itemsInError": 1,
  "itemsErrors": [
    {
      "itemPosition": 2,
      "reason": "The item must have a valid price (higher than 0)"
    }
  ]
}

possible errors are:

missing_params: missing mandatory params

internal_server_error: generic error

Example

{
    "saleCode": "SALDI2023",
    "period": 1,
    "items": [
        {
            "itemCode": "00001-BODY",
            "price": "20"
        },
        {
            "itemCode": "0000LODO2",
            "discount": "50"
        }
    ],
    "callbackUrl": "https://callback/c6dbd95b-8c9e-446e-bb73-bc42504ca414"
}

Fields

Price list

Field	Description	Type	Mandatory
saleCode	Profile sale code	String	✓
period	Period number (1,2 or 3)	String	✓
items	Array of items prices to insert	array (max length 100)	✓

Items

Field	Description	Type	Mandatory
itemCode	item code	String	✓
price	Price	number	✓ (if discount is not set)
discount	Discount percentage	number	✓ (if price is not set)

The field callbackUrl is optional, and if specified, a request to that URL will be made after the prices import has finished.

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,
    "items": [
        {
            "itemCode": "00001-BODY",
            "price": "20"
        },
        {
            "itemCode": "0000LODO2",
            "discount": "50"
        }
    ],
    "callbackUrl": "https://callback/c6dbd95b-8c9e-446e-bb73-bc42504ca414"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add item price to sale period

Example

Fields

Price list

Items

Request

Request Code Samples

Responses

Add item price to sale period

Example#

Fields#

Price list#

Items#

Request

Request Code Samples

Responses

Example

Fields

Price list

Items