insert product assortment

Insert Store's Assortment

This API allows a retail system to add a product to a store’s assortment, making it searchable and selectable for store employees on the Mobile Shop POS (Point of Sale) application, with or without network access.

Additional Considerations

Regularly update and manage the inventory list to ensure MobileShop application data remains accurate and synchronization times are optimized.

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 product must exist within the system's catalog.

The specified entity_code (store code) must be valid and exist.

Main Success Scenario

The API client makes a POST request with item code and the specified entity_code (store identifier) to add the product to the store’s assortment.

If the addition is successful, the API returns a confirmation with an internal code (prog_id) indicating the product has been added to the store’s assortment.

{
  "entity_code": "{{entity_code}}"
}

Alternate Flows

Product Already in Assortment: If the product is already added to the store’s assortment, the API returns an error message:

{
  "message": "Unique constraint error"
}

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 a product to a store’s assortment:

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

insert product assortment

Insert Store's Assortment#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert Store's Assortment

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js