Item planning stock

Endpoints

Create new item planning stock

/companies/{companycode}/item-planning-stocks

Description

Returns created item planning stock.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ItemPlanningStock

Responses

HTTP Code Description Schema

201

Successfully created

ItemPlanningStock

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/item-planning-stocks

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Item > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/item-planning-stocks/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportItemPlanningStockList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

ImportItemPlanningStockList

Name Value

callback
optional

string

data
optional

ItemPlanningStock list

parameters
optional

ItemPlanningStockParameters

ItemPlanningStock

Item planning stock data structure.

Name Description Value Business Rules

companyCode
required

Current company code

string

2 characters max

depositCode
optional

Deposit code

string

10 characters max

establishmentCode
required

Current establishment code

string

2 characters max

itemCode
required

Item code

string

20 characters max

parameterCode
required

Parameter code

string

(MINIMUM_SALES_HEDGE, MINIMUM_INVENTORY_HEDGE, MAXIMUM_INVENTORY_HEDGE, SAFETY_STOCK, MAXIMUM_STOCK)

parameterUnit
required

Parameter unit

string

Within (DAY, SALES_DAY, WEEK) if parameterCode = MINIMUM_SALES_HEDGE Within (DAY, WEEK, WORKING_DAY) if parameterCode = MINIMUM_INVENTORY_HEDGE Within (DAY, WEEK) if parameterCode = MAXIMUM_INVENTORY_HEDGE
5 characters max if parameterCode = SAFETY_STOCK ou MAXIMUM_STOCK

parameterValue
required

Parameter value

double

ItemPlanningStockParameters

Item planning stock parameters structure.

Even if parameters are optional and empty, its should be send in request
Name Description Value Business Rules

establishmentCode
optional

Establishment code

string

2 characters max

depositCodes
optional

List of deposit codes

list

10 characters max

parameterTypes
optional

List of parameter types

list (MINIMUM_SALES_HEDGE, MINIMUM_INVENTORY_HEDGE, MAXIMUM_INVENTORY_HEDGE, SAFETY_STOCK, MAXIMUM_STOCK)

Example of JSON that can be send:

{
    "data": [
        {
            "companyCode": "cCode",
            "establishmentCode": "01",
            "itemCode": "itemCode1",
            "parameterCode": "MINIMUM_SALES_HEDGE",
            "parameterUnit": "WEEK",
            "parameterValue": "2"
        }
    ],
    "parameters": {
        "establishmentCode" : "01",
        "depositCodes" : [],
        "parameterTypes" : []
    }
}