Item planning internal purchase

Endpoints

Create new item planning internal purchase

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

Description

Returns created item planning internal purchase.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ItemPlanningInternalPurchase

Responses

HTTP Code Description Schema

201

Successfully created

ItemPlanningInternalPurchase

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/item-planning-internal-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-internal-purchases/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportItemPlanningInternalPurchaseList

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

ItemPlanningInternalPurchase

Item planning internal purchase data structure.

Name Description Value Business Rules

arrivalDepositCode
optional

Arrival deposit code

string

10 characters max

arrivalEstablishmentCode
required

Arrival establishment code

string

2 characters max

companyCode
required

Current company code

string

2 characters max

itemCode
required

Item code

string

20 characters max

parameterCode
required

Parameter code

string

(MINIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_DELAY)

parameterUnit
required

Parameter unit

string

if MINIMUM_REPLENISHMENT or MULTIPLE_REPLENISHMENT, it is a unit code
if REPLENISHMENT_DELAY, parameterUnit = "WEEK" or it is null if a transfer time code is used

parameterValue
optional

Parameter value

double

if REPLENISHMENT_DELAY, it is null

startDepositCode
optional

Start deposit code

string

10 characters max

startEstablishmentCode
required

Start establishment code

string

2 characters max

transferTimeCode
required if REPLENISHMENT_DELAY

Transfer time code

string

ImportItemPlanningInternalPurchaseList

Name Value

callback
optional

string

data
optional

ItemPlanningInternalPurchase list

parameters
optional

ItemPlanningInternalPurchaseParameters

ItemPlanningInternalPurchaseParameters

Item planning internal purchase parameters structure.

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

parameterTypes
optional

List of parameter types

list (MINIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_DELAY)

Example of JSON that can be send:

{
    "data": [
        {
            "companyCode": "cCode",
            "startEstablishmentCode": "01",
            "arrivalEstablishmentCode": "02",
            "itemCode": "itemCode1",
            "parameterCode": "REPLENISHMENT_DELAY",
            "parameterUnit": "WEEK",
            "parameterValue": "6"
        }
    ],
    "parameters": {
        "parameterTypes" : []
    }
}