To insert a sale profile, 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",
    "description": "Saldi anno 2023",
    "currency": "EUR",
    "loyaltyOnly": false,
    "seasonCode": "231",
    "connectedCatalogCode": "ECOMMERCE",
    "discountCausal": "SALDO"
}

Fields

Field	Description	Type	Mandatory
saleCode	Profile sale code	String	✓
description	Sale profile description	String	✓
currency	Currency code	String	✓
loyaltyOnly	Defines whether the sale profile is intended only for loyalty customers	Boolean	default false
seasonCode	Season code	String	✓
connectedCatalogCode	Catalog code	String
discountCausal	Discount causal code	String	✓

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "saleCode": "SALDI2023",
    "description": "Saldi anno 2023",
    "currency": "EUR",
    "loyaltyOnly": false,
    "seasonCode": "231",
    "connectedCatalogCode": "ECOMMERCE",
    "discountCausal": "SALDO"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert sale profile

Example

Fields

Request

Request Code Samples

Responses

Insert sale profile

Example#

Fields#

Request

Request Code Samples

Responses

Example

Fields