Insert stock

Insert Product Stock in a Store or Warehouse

This API allows the insertion of product stock for a specific store or warehouse. The stock can be specified using either the product's barcode or its SKU details.

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 entity_code must correspond to a valid store or warehouse in the system.

The item_code must exist in the product catalog.

For barcode-based stock entry, the barcode and item_code combination must match an existing product.

For SKU-based stock entry, the dimension_level1 and dimension_level2 values must match the product's composition and dimensions.

Main Success Scenario

The API client sends a request to insert stock using the correct payload.

Request Example

The 4ws.trade API returns a success response with success: true.
If a callback URL is provided, 4ws.suite sends the result to the specified endpoint after processing.

A successful request returns the following response:

Response Example

To verify if the request has been processed correctly, you can include the callback parameter in the body, specifying the URL of an endpoint to receive the processing result. The callback response will depend on the data provided in the request. For example, if stock is inserted successfully, a message similar to the following will be sent to the callback:

Callback Response Example

Alternate Flows

Authentication Error: If the client does not provide valid credentials, an error response is returned.

Error Example

Invalid entity_code: If the entity_code is not found, the API returns HTTP 422 with the following error:

Error Example

Invalid item_code: If the item_code does not exist, the API returns HTTP 422 with the following error:

Error Example

Invalid barcode: If the barcode does not exist, the API returns HTTP 422 with the following error:

Error Example

Invalid SKU Combination: If the SKU details do not match the product's composition and dimensions, the API returns HTTP 422 with the following error:

Error Example

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

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 Request:

Request

Body Params application/json

Example

{
    "entity_code": 0,
    "quantity_stock": 0,
    "quantity_available": 0,
    "barcode": "string",
    "item_code": "string",
    "dimension_level1": "string",
    "dimension_level2": "string",
    "dimension_level3": "string",
    "dimension_level4": "string",
    "dimension_level5": "string",
    "callback": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert Product Stock in a Store or Warehouse#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert Product Stock in a Store or Warehouse

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js