Defining Product Pricing

Use Case: Defining Product Pricing

Use Case Description

This use case describes how an external system can define the pricing of a product after it has been registered. The external system must first request the creation of a price list (which can be for sales, purchase, or invoice) if it does not already exist. Subsequently, it will insert the product with its price (including an optional validity date) and then associate the price list with a site. This process ensures that the product's price during a sale is determined based on the associated price list, product, and date of sale.

Actors

External System: The system initiating the request to define product pricing.

4ws.suite: The system providing the pricing and product management functionalities.

Preconditions

The external system must have the necessary credentials to access the 4ws.suite API.

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

APIs Used

Insert Lists: To create a price list.

Insert product price: To define the price of a product within a price list.

Insert entity on pricelist: To associate a price list with a site.

Main Success Scenario

The external system checks if the necessary price list exists. If not, it creates the price list using the Insert Lists API.

The external system inserts the product price into the price list using the Insert product price API, specifying the price validity date if necessary.

The external system associates the price list with a site using the Insert entity on pricelist API.

The product's price is determined based on the associated price list, product, and the date of sale.

Alternate Flows

If the price list already exists, the external system skips the price list creation step.

If an error occurs during any API call, the external system handles the error based on the message provided in the response.

JSON Structure

Insert Lists

{
    "price_list_code": "{{price_list_code}}",
    "price_list_type": "V",
    "description": "Listino vendita",
    "start_date": "2024-01-01",
    "end_date": "2999-12-31",
    "currency": "EUR",
    "active": "Y"
}

Example invocation:

curl --location -g --request POST 'https://fake_url.com/api?cmd=insertList&applicationId=MOBILE_SHOP&appId=MOBILE_SHOP' \
--header 'Content-Type: application/json' \
--data-raw '{
    "price_list_code": "SALE2024",
    "price_list_type": "V",
    "description": "Sales Price List 2024",
    "start_date": "2024-01-01",
    "end_date": "2999-12-31",
    "currency": "EUR",
    "active": "Y"
}'

Insert Entity on Price List

Params	Description	Type	Mandatory
price_list_type	Type of price list: "V" for sales, "P" for purchase, "I" for invoice.	Varchar(1)	✓
price_list_code	Code of the price list to which the site/entity will be associated.	Varchar(250)	✓

{
    "entity_code": "1008"
}

Example invocation:

curl --location -g --request POST 'https://fake_url.com/api?cmd=insertEntityOnPriceList&applicationId=MOBILE_SHOP&appId=MOBILE_SHOP&price_list_type=V&price_list_code=SALE2024' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entity_code": "1008"
}'

Insert Product Price

Params	Description	Type	Mandatory
price_list_type	Type of price list: "V" for sales, "P" for purchase, "I" for invoice.	Varchar(1)	✓
price_list_code	Code of the price list to which the product price will be added.	Varchar(250)	✓

{
    "item_code": "{{item_code}}",
    "start_date": "{{start_date}}",
    "price": "{{price}}"
}

Example invocation:

curl --location -g --request POST 'https://fake_url.com/api?cmd=insertProductPrice&applicationId=MOBILE_SHOP&appId=MOBILE_SHOP&price_list_type=V&price_list_code=SALE2024' \
--header 'Content-Type: application/json' \
--data-raw '{
    "item_code": "PROD001",
    "start_date": "2024-01-01",
    "price": 99.99
}'

Callback Response

Each API provides a response that includes a message field indicating success or any errors.

If successful, the response will include a success message:

{
    "message": "Success"
}

If there is an error, the response will include an error message:

{
    "message": "Price list code not found"
}

Defining Product Pricing

Use Case: Defining Product Pricing

Use Case Description

Actors

Preconditions

APIs Used

APIs Used

Main Success Scenario

Alternate Flows

JSON Structure

Insert Lists

Insert Entity on Price List

Insert Product Price

Callback Response

Sequence Diagram

Code Examples in Node.js

Defining Product Pricing

Use Case: Defining Product Pricing#

Use Case Description#

Actors#

Preconditions#

APIs Used#

APIs Used#

Main Success Scenario#

Alternate Flows#

JSON Structure#

Insert Lists#

Insert Entity on Price List#

Insert Product Price#

Callback Response#

Sequence Diagram#

Code Examples in Node.js#

Use Case: Defining Product Pricing

Use Case Description

Actors

Preconditions

APIs Used

APIs Used

Main Success Scenario

Alternate Flows

JSON Structure

Insert Lists

Insert Entity on Price List

Insert Product Price

Callback Response

Sequence Diagram

Code Examples in Node.js