Insert Entity On Price Lists

This API allows adding an entity (store) to a specific price list by specifying the PRICE_LIST_TYPE (type of price list), PRICE_LIST_CODE (price list code), and the entity_code (store code).

For more detail about product pricing features please refer to Product pricing and Defining Product Pricing.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Preconditions

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

The PRICE_LIST_TYPE and PRICE_LIST_CODE must correspond to an existing price list in the system.

The entity_code must correspond to an existing entity (store) in the system.

Main Success Scenario

The API client sends a POST request with the PRICE_LIST_TYPE, PRICE_LIST_CODE, and entity_code.

If the request is successful, the system will return a response confirming the entity addition, including the prog_id of the inserted entity.

INFO

To get the list of locations you can query the suite with the service Get entities

Alternate Flows

Price List Not Found: If the specified PRICE_LIST_CODE does not exist, the API returns an error message:

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

Entity Not Found: If the specified entity_code does not exist, the API returns an error message:

{
  "message": "Entity not found with entity_code: {{entity_code}}"
}

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Example Node.js code for adding an entity to a price list:

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert Entity On Price Lists