Unit

Endpoints

Create new unit

/units

Description

Returns created unit.

Parameters

Type Name Schema

Body

body
required

Unit

Responses

HTTP Code Description Schema

201

Successfully created

Unit

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/units

Description

Returns entities.

Parameters

Type Name Description Schema

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Unit > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/units/import

Parameters

Type Name Schema

Body

body
required

ImportUnitList

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

Get one unit

/units/{code}

operation.deprecated

Description

Returns retrieved unit.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

5 characters max

Responses

HTTP Code Description Schema

200

Successful

Unit

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete unit

/units/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

5 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Unit

Unit data structure.

Name Description Value Business Rules

code
required

Unit code

string

5 characters max
All characters in uppercase accepted except characters \ ; | " < > and spaces at the beginning and at the end

ediReference
optional

EDI reference

string

IN(AUC=None,PCE=Piece,CT=Box,PC=Parcel,TB=Bac,LTR=Litre,KGM=Kilogram,RCA=Roll,BJ=Bucket,TRE=Trolley,_201=pallet ISO 1/1 120*80,X1=pallet (X1),X2=Box pallet,_202=pallet ISO 1/2 60*80,CS=Case,BG=Bag)

label
required

Unit label

string

50 characters max

nbDecimals
required

Decimals number

integer

publicUuid
optional
read-only

Unit public uuid

string

unitFamily
required

Unit family

string

IN(PDS=Weigh,AUT=other,CDT=Piece,TPS=Time,LON=Length,TEM=Temperature,VOL=Volume)

validityEndDate
optional

Validity end date

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportUnitList

Name Value

callback
optional

string

data
optional

Unit list