Item planning purchase

Endpoints

Create new item planning purchase

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

Description

Returns created item planning purchase.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ItemPlanningPurchase

Responses

HTTP Code Description Schema

201

Successfully created

ItemPlanningPurchase

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

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

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-purchases/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportItemPlanningPurchaseList

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

ImportItemPlanningPurchaseList

Name Value

callback
optional

string

data
optional

ItemPlanningPurchase list

parameters
optional

ItemPlanningPurchaseParameters

ItemPlanningPurchase

Item planning purchase 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_REPLENISHMENT, MAXIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_PERIOD, REPLENISHMENT_DELAY)

parameterUnit
required

Parameter unit

string

Within (DAY, WEEK) if parameterCode = REPLENISHMENT_PERIOD Within (DAY, WEEK, WORKING_DAY) if parameterCode = REPLENISHMENT_DELAY
5 characters max otherwise

parameterValue
required

Parameter value

double

ItemPlanningPurchaseParameters

Item planning purchase 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_REPLENISHMENT, MAXIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_PERIOD, REPLENISHMENT_DELAY)

Example of JSON that can be send:

{
    "data": [
        {
            "companyCode": "cCode",
            "establishmentCode": "01",
            "itemCode": "itemCode1",
            "parameterCode": "MINIMUM_REPLENISHMENT",
            "parameterUnit": "KG",
            "parameterValue": 1000
        }
    ],
    "parameters": {
        "establishmentCode": "01",
        "depositCodes": [],
        "parameterTypes" : []
    }
}