Update season

Updating a Product Season

This document outlines the API that an external system can use to update the season of a product for sales.

This API allows an external system to update an existing season, changing its season type or description. Seasons are categorized into predefined types such as Spring/Summer, Autumn/Winter, etc.
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

Languages

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

Actors

API Client: The system or user initiating the request.

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

Preconditions

The season code must already exist in the system.

The season value must be one of the predefined categories.

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

Main Success Scenario

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

Example Success Response:

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

Alternate Flows

Season Code Not Found:
If the provided season_code does not exist in the system, the following error will be returned:

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

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

Code Example in Node.js

This Node.js example demonstrates how to update an existing product season using the provided API.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Updating a Product Season#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Updating a Product Season

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js