To insert one or more entities to a price list or sale period, it's necessary to make a POST call, passing a JSON body as specified below.

To add one or more entities to a sale period you can pass:

saleCode: "The sale profile code"

period: "The sale period"

The web service response will be composed of:

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

message: Error message

invalidEntities: List of invalid entity (in case of success=false)

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

invalid_price_list: invalid list code or type

invalid_entities: invalid entity code

internal_server_error: generic error

Example

    {
      "priceList": "LIST_1001_2",
      "priceListType": "SALE",
      "entities": [
        {
          "entityCode": "2"
        },
        {
          "entityCode": "60"
        }
      ]
    }

Fields

Field	Description	Type	Mandatory
priceList	Price list code	String	✓ (if saleCode is not set)
saleCode	Profile sale code	String	✓ (if priceList is not set)
period	Period of the sale	Int	✓ (if saleCode is set)
priceListType	Price list type	String	✓
entities	List of entity	array (max 100 elements)	✓

entities

Field	Description	Type	Mandatory
entityCode	Entity code	String	✓

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

    {
      "priceList": "LIST_1001_2",
      "priceListType": "SALE",
      "entities": [
        {
          "entityCode": "2"
        },
        {
          "entityCode": "60"
        }
      ]
    }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add entity to price list

Example

Fields

entities

Request

Request Code Samples

Responses

Add entity to price list

Example#

Fields#

entities#

Request

Request Code Samples

Responses

Example

Fields

entities