Insert season

Creating a New Product Season

This API allows an external system to create a new season, associating it with products for sale. Seasons are identified by a code and are classified into specific categories (e.g., Spring/Summer, Autumn/Winter).

This document outlines the API that an external system can use to register a new season for product sales.
A season is characterized by a season and a year.

For example, the season "Knitwear SS 2024" identifies the season for knitwear products for Spring/Summer 2024, while "AI 2025" identifies the season for Autumn/Winter 2025.

season_code: A unique identifier for the season.

description_it: The description of the season in Italian.

year: The year for which the season applies.

season: The season type, where the values correspond to:

Code	Season Name
1	Spring/Summer
2	Autumn/Winter
3	Continuous
4	No Season

NOTE

Once a new collection is registered, it can be used in the new product creation functionality from the suite or through the product insertion service insert product.

Actors

API Client: The system or user initiating the request.

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

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Preconditions

The season code must be unique.

The season value must correspond to one of the predefined categories.

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

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Main Success Scenario

If the season creation is successful, the system will return an HTTP 200 response with the internal program ID (prog_id) and the season_code.

Example Success Response:

{
  "season": {
    "prog_id": 994,
    "season_code": "EXAMPLE_SEASON"
  }
}

Alternate Flows

Season Code Already Exists:
If the season code is not unique and already exists in the system, the following error will be returned:

{
  "message": "season_code with {season_code} already exists"
}

HTTP Status: 422 Unprocessable Entity

Invalid Season Type:
If the provided season value does not match one of the predefined categories (1, 2, 3, 4), the following error will be returned:

{
  "message": "season with {season} not found"
}

HTTP Status: 422 Unprocessable Entity

Best Practices

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

Sequence Diagram

Below is a sequence diagram representing the process of creating a new season.

Code Example in Node.js

This Node.js example demonstrates how to create a new season using the provided API.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
   "season_code":"EXAMPLE_SEASON",
   "description_it":"Stagione di esempio",
   "year":2024,
   "season":4
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Creating a New Product Season#

Actors#

Languages#

Preconditions#

Languages#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Creating a New Product Season

Actors

Languages

Preconditions

Languages

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js